Get webhook endpoint

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

GET

/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

Get webhook endpoint

application/json

response

id*string

url*string

eventTypes*array<string>

brandIds*array<number>|null

status*string

disabled_by_failures means Koast gave up after ~3 days of failed deliveries; enable it again once fixed.

Value in"enabled""disabled""disabled_by_failures"

disabledReason*string|null

disabledAt*string|null

consecutiveFailures*integer

Range-9007199254740991 <= value <= 9007199254740991

lastSuccessAt*string|null

lastFailureAt*string|null

lastError*string|null

secretRotationExpiresAt*|

While set, deliveries are signed with both the new and the previous secret.

createdAt*string

updatedAt*string

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

{  "id": "string",  "url": "string",  "eventTypes": [    "string"  ],  "brandIds": [    0  ],  "status": "enabled",  "disabledReason": "string",  "disabledAt": "string",  "consecutiveFailures": -9007199254740991,  "lastSuccessAt": "string",  "lastFailureAt": "string",  "lastError": "string",  "secretRotationExpiresAt": "string",  "createdAt": "string",  "updatedAt": "string"}

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