Create Webhook
POST https://api.getpostman.com/webhooks?workspace={{workspaceId}}
Creates a webhook that triggers a collection with a custom payload. You can get the webhook's URL from the webhookUrl property in the endpoint's response.
Include the following properties in a webhook object in the request body:
-
name— The webhook's name. On success, the system creates a new monitor with this name in the Monitors tab. -
collection— The collection UID to trigger when calling this webhook.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
workspace | string | Optional. A workspace ID in which to create the webhook. |
If you do not include this query parameter, the system creates the webhook in your "My Workspace" workspace. | | `` | null | | |
Request Body
{"webhook"=>{"name"=>"{{webhookName}}", "collection"=>"{{collectionUid}}"}}
RESPONSES
status: OK
{"webhook":{"id":"1ed9023a-a863-4290-85cb-5e27cab17932","name":"Externally Triggered Monitor for A(i)ppealing Companies","collection":"24483733-6a545bfb-a72f-4ee8-a1fe-469a34d7cf8b","webhookUrl":"https://newman-api.getpostman.com/run/24483733/53397257-e8b0-4840-88cc-41d1327bf9e2","uid":"24483733-1ed9023a-a863-4290-85cb-5e27cab17932"}}