Webhooks
Available from Phase 5
/api/v1/webhooksAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Query Parameters
1 <= value <= 200501 <= lengthResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/webhooks"{ "data": [ null ], "nextCursor": "string"}/api/v1/webhooksAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Header Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "types": [ "set.published" ] }'null/api/v1/webhooks/{id}An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthResponse Body
application/json
application/json
curl -X DELETE "https://example.com/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"nullBandwise is an independent product built on TypeSafe's System One models. It is not TypeSafe's documentation. For the System One models themselves, see docs.typesafe.ai.