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. |
Request Body
{"webhook"=>{"name"=>"{{webhookName}}", "collection"=>"{{collectionUid}}"}}