Webhooks
Configure signed webhooks for delivery and lifecycle events.
Lists every webhook endpoint configured for the App. The signing secret is not returned by this route.
Path Parameters
App ID
Response Body
application/json
curl -X GET "https://example.com/v1/apps/string/webhooks"[ { "app_id": "string", "created_at": "string", "id": "string", "url": "string" }]Registers a webhook endpoint URL for the App and returns its signing secret exactly once.
Path Parameters
App ID
Request Body
application/json
Webhook target URL
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/apps/string/webhooks" \ -H "Content-Type: application/json" \ -d '{}'{ "app_id": "string", "created_at": "string", "id": "string", "secret": "string", "url": "string"}Fetches a single webhook config by ID, scoped to the App. The signing secret is not returned by this route.
Path Parameters
App ID
Webhook ID
Response Body
application/json
curl -X GET "https://example.com/v1/apps/string/webhooks/string"{ "app_id": "string", "created_at": "string", "id": "string", "url": "string"}Updates a webhook's target URL.
Path Parameters
App ID
Webhook ID
Request Body
application/json
New webhook target URL
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/v1/apps/string/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{ "app_id": "string", "created_at": "string", "id": "string", "url": "string"}Deletes a webhook config by ID, scoped to the App.
Path Parameters
App ID
Webhook ID
Response Body
curl -X DELETE "https://example.com/v1/apps/string/webhooks/string"