POST /public/v1/webhook-subscriptions
This operation creates a new webhook subscription by specifying its details.
Servers
- https://api.pandadoc.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Set a name for the Webhooks subscription. |
active |
Boolean | No |
Set the status of the Webhooks subscription. Default value: true |
url |
String | Yes |
Set the Webhooks subscription URL. |
triggers[] |
Array | Yes |
Set trigger events for the Webhooks subscription. |
payload[] |
Array | No |
Set a payload structure. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.