API referenceWebhooks

Delete webhook endpoint

Deletes the webhook endpoint. Deliveries still queued for it are not sent.

DELETE
/v1/webhooks/{endpointId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

endpointId*string

The webhook endpoint id (ep_…).

Length1 <= length <= 64

Response Body

Delete webhook endpoint

curl -X DELETE "https://example.com/v1/webhooks/string" \  -H "Authorization: Bearer koast_sk_..."
Empty

Required scope: write. CLI: koast delete-webhook-endpoint, see Webhooks commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.

Get webhook endpoint

Returns one webhook endpoint, including its status and the outcome of its latest deliveries.

Update webhook endpoint

Updates the URL, event types, brand filter or status of a webhook endpoint. Setting status to enabled also clears a disable caused by failed deliveries.