API referenceWebhooks

List webhook endpoints

Lists every webhook endpoint of the organization (at most 20). Requires an organization owner or admin when called with an OAuth token.

GET
/v1/webhooks
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.

Response Body

List webhook endpoints

application/json
  1. response
data*array<>
nextCursor*null
curl -X GET "https://example.com/v1/webhooks" \  -H "Authorization: Bearer koast_sk_..."
{  "data": [    {      "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"    }  ],  "nextCursor": null}

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