POST /webhooks
Create a webhook that triggers a collection with your custom payload.
You can specify the webhook name and the collection to trigger by using the following attributes of the webhook object on your JSON body:
name: the name of the webhook that you're creating.collection: the ID of the collection that you want to trigger once this webhook is called.
Once created, the webhook URL can be retrieved by accessing the webhookUrl attribute of the webhook object on the response JSON payload.
Servers
- https://api.getpostman.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
webhook |
Object | No | |
webhook.name |
String | No | |
webhook.collection |
String | No |
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.