For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve a webhook

Returns a single webhook, active or inactive.

get
/whisperer/hooks/{id}/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idintegerRequired

The unique identifier of the webhook.

Responses
200

The webhook.

application/json

A webhook subscription.

idintegerOptional

The unique identifier of the webhook.

created_datestring · date-timeOptional

When the webhook was registered.

modified_datestring · date-timeOptional

When the webhook was last modified.

target_urlstring · max: 255Optional

The URL events are posted to.

is_activebooleanOptional

Whether the webhook receives events.

secret_keystring · max: 124 · nullableOptional

The key requests are signed with, returned as stored; null when requests are not signed.

event_typestring · max: 124Optional

The event type the webhook subscribes to.

callbackstring · max: 64 · nullableOptional

Reserved for platform integrations; normally null.

get/whisperer/hooks/{id}/
GET /api/v1/remote/1/whisperer/hooks/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": 12,
  "retry_countdown_config": {
    "choice": "exponential",
    "kwargs": {
      "base": 2,
      "factor": 30,
      "limit": 3600
    }
  },
  "created_date": "2026-10-01T08:15:42.120394Z",
  "modified_date": "2026-10-01T08:15:42.120394Z",
  "target_url": "https://hooks.example.com/commerce",
  "is_active": true,
  "secret_key": "change-me",
  "event_type": "user_registered",
  "callback": null,
  "additional_headers": {
    "X-Api-Key": "example-key"
  },
  "config": {}
}

Last updated

Was this helpful?