Skip to main content
GET
Get a webhook endpoint

Authorizations

X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-07-16 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-16"

Path Parameters

id
string
required

Opaque endpoint id.

Example:

"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

Response

Endpoint found

id
string
required

Opaque endpoint id (we_).

Example:

"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

object
string
required
Example:

"webhook_endpoint"

url
string
required
Example:

"https://api.acme.dev/aurous-webhook"

events
string[]
required
Example:
secret_preview
string
required

Truncated preview of the active secret. Always present in dashboard hints.

Example:

"whsec_8jK...ABCD"

is_active
boolean
required
Example:

true

consecutive_failures
number
required

Consecutive 4xx/5xx/timeout/connect errors since the last successful delivery. The endpoint auto-disables at >=20 with no success in 24h (emits webhook.endpoint_disabled to other active endpoints + an email to the team owner).

Example:

0

last_success_at
object | null
required

Timestamp of the most recent 2xx delivery; null if never.

Example:

"2026-05-04T01:00:00Z"

last_failure_at
object | null
required

Timestamp of the most recent failed delivery (4xx/5xx/timeout/connect/TLS); null if never.

Example:

"2026-05-04T00:55:00Z"

metadata
object
required

Echoed customer metadata.

Example:
created_at
string
required
Example:

"2026-05-03T14:00:00Z"

updated_at
string
required
Example:

"2026-05-03T14:00:00Z"

description
object | null
Example:

"Production webhook"

secret
object | null

Plaintext webhook secret. Returned EXACTLY ONCE on POST + /rotate_secret responses; null on every other read. Store on your side and use to verify the Aurous-Webhook-Signature header.

Example:

"whsec_8jKpQ4nXabc1234abc..."

api_key_id
string | null

Public id of the API key this endpoint is bound to, or null for a catch-all endpoint. When set, only events generated with that key are delivered here (most-specific routing). Reverts to null if the key is deleted.

Example:

"key_06FD019S0HGR87NSH2KA72HZAC"

api_key_name
string | null

Display name of the bound API key; null when unscoped (catch-all).

Example:

"Production key"