Cowdidocs
API ReferenceWebhooks

Send a test delivery

POST
/v1/webhooks/{webhookId}/test

Sends a signed webhook.test delivery to the registered URL, through the same client and signing every real delivery uses. Requires the org:connect:write permission. A webhook that has since been repointed inside a private network is suspended rather than called. Returns 404 when the caller's organization has no webhook with this id, and 429 when a test ran within the per-webhook cooldown. The response always answers 200 and reports what the webhook did. A test is not recorded in the delivery log.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Path Parameters

webhookId*string

Unique identifier of the webhook.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/webhooks/550e8400-e29b-41d4-a716-446655440000/test"
{  "delivered": true,  "http_status": 200,  "response_snippet": {    "status": "ok"  },  "error": "Connection timed out after PT5S",  "duration": "PT0.412S"}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "BAD_REQUEST",  "description": "Invalid input"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Revoke a signing key DELETE

Revokes a key the receiver has stopped using. The last remaining key cannot be revoked, because a webhook that cannot sign sends deliveries that a receiver refuses. Requires the `org:connect:write` permission. Returns 404 when the caller's organization has no webhook with this id, or the webhook has no such key, and 409 when this is the only key the webhook has.

List the caller's organizations GET

List every organization the caller has a membership in. Requires an authenticated user token; a caller always sees only their own memberships. Returns an empty list when the caller has no membership. Roles are not included: they live in WorkOS, not in this projection.