API referenceWebhooks

Send webhook test event

Queues a signed ping event for the endpoint, regardless of its event types and brand filter. The outcome appears in its deliveries. A disabled endpoint answers 409 conflict ("Enable the endpoint first.") and nothing is queued.

POST
/v1/webhooks/{endpointId}/test

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

Header Parameters

Idempotency-Key?string

Retrying with the same key within 24 hours returns the first response without acting again.

Lengthlength <= 255

Response Body

Send webhook test event

application/json
  1. response
eventId*string
queued*boolean
curl -X POST "https://example.com/v1/webhooks/string/test" \  -H "Authorization: Bearer koast_sk_..."
{  "eventId": "string",  "queued": true}

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

Get webhook secret

Returns the current whsec_… signing secret of the endpoint. Requires the write scope: the secret lets its holder sign deliveries, so a read-only key cannot reveal it.

List workflows

Lists the organization's workflows, multi-step automations built from nodes such as apply template, launch, review gate and Slack notify, with their status, run count and last run time. Results are cursor-paginated.