List webhook endpoints — API

GET/api/v1/webhooks

Scope: webhooks:manage

Every webhook endpoint in the organization, whoever created it. Signing secrets are never returned. Requires the "webhooks:manage" scope.

Example request#

bash

curl -X GET "https://your-site.awrora.app/api/v1/webhooks" \
  -H "Authorization: Bearer $AWRORA_API_KEY"

Responses#

200The endpoints. This list is not paginated — an organization may have at most 10 — so has_more is always false.
401Missing, invalid, revoked or expired API key — codes "api_key_missing", "api_key_invalid", "api_key_revoked", "api_key_expired".
403The API app is off, the plan does not include the API, or the key lacks the required scope — codes "app_not_enabled", "plan_upgrade_required", "insufficient_scope" (the last carries "required_scope").
429Rate limit exceeded — code "rate_limited". See the x-ratelimit-* headers.
500Something went wrong on our side — code "internal_error".

Response 200

Field Type Description

datarequired

object[]

The page of results, in the requested order.

Field	Type	Description
`id`required	string	Awrora id (UUID) for the endpoint.
`url`required	string	The https URL deliveries are POSTed to.
`description`required	string \| null	Free-text note, or null.
`events`required	string[]	The event types this endpoint receives. Test deliveries ignore this list.
`status`required	string	enabled = receiving; disabled = turned off by the merchant; auto_disabled = turned off by Awrora after 72 hours without a successful delivery. PATCH status back to "enabled" to resume — that also resets the failure counter. `"enabled""disabled""auto_disabled"`
`source`required	string	"api" when created through this API, "admin" when created in Awrora. `"admin""api"`
`consecutive_failures`required	integermin -9007199254740991 · max 9007199254740991	Failed deliveries in a row. Reset to zero by the next success.
`last_success_at`required	string \| null	ISO 8601 with offset, or null.
`last_failure_at`required	string \| null	ISO 8601 with offset, or null.
`created_at`required	string	ISO 8601 timestamp with offset.
`updated_at`required	string	ISO 8601 timestamp with offset.

has_morerequired

boolean

True when more results exist after this page. Fetch them with next_cursor.

next_cursorrequired

string | null

Pass this back as ?starting_after= to fetch the next page. Null when has_more is false. Opaque — do not parse it.

200 response

{
  "data": [
    {
      "id": "res_8f2k3n",
      "url": "https://example.com/webhooks/awrora",
      "description": "string",
      "events": [
        "string"
      ],
      "status": "enabled",
      "source": "admin",
      "consecutive_failures": -9007199254740991,
      "last_success_at": "string",
      "last_failure_at": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}