Register an outbound webhook endpoint
Requires a current workspace administrator personal access token. The signing secret is returned once. HTTPS port 443 and public DNS are required.
Requires a current workspace administrator personal access token. The signing secret is returned once. HTTPS port 443 and public DNS are required.
Authorization
machineBearer Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.
In: header
Path Parameters
Workspace UUID. It must match the workspace bound to the credential.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhook-endpoints" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "url": "http://example.com", "subscriptions": [ "story.created" ] }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c", "name": "string", "url": "http://example.com", "status": "active", "secretGeneration": 1, "subscriptionGeneration": 1, "subscriptions": [ "story.created" ], "consecutiveFailures": 0, "lastSuccessAt": "2019-08-24T14:15:22Z", "disabledAt": "2019-08-24T14:15:22Z", "disabledReason": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "signingSecret": "string"}