Create Webhook

POST

/webhooks

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.getpostman.com/webhooks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook": {
        "collection": "{{collection_id}}",
        "name": "{{webhook_name}}"
    }
}'

Response Example

{}

Request

Query Params

workspace

string

optional

Body Params application/json

webhook

object

optional

collection

string

optional

Example:

name

string

optional

Example:

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2023-08-15 05:41:04

Run a Monitor

All workspaces