Create a webhook subscription
Registers a delivery URL for the given events and returns the new subscription together with its `signingSecret` — the only time the secret is returned other than on rotate. The URL must be `http(s)`, ≤ 2048 chars, and must not point at a private / loopback / link-local address (literal IPs are rejected outright; hostnames are DNS-resolved and checked). Deployments that require HTTPS reject `http://` URLs except for `localhost`.
Registers a delivery URL for the given events and returns the new subscription together with its signingSecret — the only time the secret is returned other than on rotate. The URL must be http(s), ≤ 2048 chars, and must not point at a private / loopback / link-local address (literal IPs are rejected outright; hostnames are DNS-resolved and checked). Deployments that require HTTPS reject http:// URLs except for localhost.
Authorization
bearerAuth In: header
Path Parameters
Unique identifier of the workspace.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "url": "http://example.com", "events": [ "task.created" ] }'{ "subscription": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "name": "string", "url": "http://example.com", "events": [ "task.created" ], "status": "active", "failedOutAt": "2019-08-24T14:15:22Z", "failedOutReason": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastSuccessAt": "2019-08-24T14:15:22Z", "lastFailureAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "signingSecret": "string"}