View event schema

Returns the JSON Schema and an example of the event in the current version.

GET/webhook-events/{event}/schemawebhooks:read

BEHAVIOR

The read looks for the identifier within the account linked to the key and returns 404 when it does not belong to the operation.

EFFECT

Does not change resources or trigger publication.

REPETITION

The operation is safe to repeat. On 429 or 5xx, use exponential backoff with jitter.

Request

eventstring · pathFull name of the event.mandatory

AuthorizationBearer ach_live_...

Acceptapplication/json

Scopewebhooks:read

Executable example

curl

curl 'https://achadu.com/api/v1/webhook-events/string/schema' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json'

Response and errors

Every response includes request_id. Lists add pagination; mutable resources return the persisted state after the operation.

200 application/json

{
  "data": {
    "id": "wh_01J...",
    "name": "Production",
    "url": "https://example.com/webhooks/achadu",
    "events": [
      "offer.created"
    ],
    "active": true,
    "created_at": "2026-08-31T18:20:00.000Z"
  },
  "request_id": "req_01J..."
}

200Operation completed.

400Invalid parameter, body or transition.

401Missing, invalid, expired or revoked key.

402The account plan does not release this interface.

403A chave precisa do escopo webhooks:read.

404Feature does not exist in this account.

409The current state prevents this operation.

413The JSON body exceeds 128 KB.

429The 120 requests per minute window has been exceeded.

View event schema

Request

Executable example

Response and errors

Related operations