Skip to main content
GET
/
webhooks
List registered webhooks
curl --request GET \
  --url https://api.godiligent.ai/webhooks \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "<string>",
    "webhook_url": "<string>",
    "is_active": true,
    "has_secret": true,
    "last_delivery_at": "2023-11-07T05:31:56Z",
    "last_delivery_status": 123,
    "events": []
  }
]

​
Endpoint

GET /webhooks Returns all webhooks registered for the authenticated customer.

​
Response

A JSON array of webhook objects. The signing secret is never returned; has_secret indicates whether one is configured.
FieldTypeDescription
idstringUnique webhook ID.
webhook_urlstringThe endpoint URL.
is_activebooleanWhether the webhook is active.
has_secretbooleanWhether a signing secret is configured.
statusstringDerived health: disabled (inactive), failing (last delivery non-2xx), or active.
last_delivery_atstring | nullISO timestamp of the most recent delivery attempt, or null if none.
last_delivery_statusnumber | nullHTTP status of the most recent delivery attempt, or null if none.
eventsstring[]Subscribed event types.

​
Example Response

[
  {
    "id": "df89eb16-4c6a-439f-b668-7cca0cd786fa",
    "webhook_url": "https://crm.example.com/diligent",
    "is_active": true,
    "has_secret": true,
    "status": "active",
    "last_delivery_at": "2025-07-31T02:51:34.155Z",
    "last_delivery_status": 200,
    "events": ["cdd_state_changed", "alert_remediated"]
  },
  {
    "id": "5a1c0b2e-9f3d-4a7b-8c6d-2e1f0a9b8c7d",
    "webhook_url": "https://warehouse.example.com/ingest",
    "is_active": false,
    "has_secret": false,
    "status": "disabled",
    "last_delivery_at": null,
    "last_delivery_status": null,
    "events": ["search_completed"]
  }
]

​
Authentication

This endpoint requires authentication. Only webhooks owned by the authenticated customer are returned.

Authorizations

​
X-API-KEY
string
header
required

Response

200 - application/json

All webhooks registered for the customer.

​
id
string

Unique ID for the webhook.

​
webhook_url
string<uri>
​
is_active
boolean
​
has_secret
boolean

Whether a signing secret is configured. The secret itself is never returned.

​
status
enum<string>

Derived health: disabled when inactive, failing when the last delivery returned a non-2xx status, otherwise active.

Available options:
active,
failing,
disabled
​
last_delivery_at
string<date-time> | null

Timestamp of the most recent delivery attempt, or null if none.

​
last_delivery_status
integer | null

HTTP status code of the most recent delivery attempt, or null if none.

​
events
enum<string>[]
Available options:
cdd_state_changed,
monitoring_alert_fired,
cdd_document_fetched,
search_completed,
alert_remediated,
flow_run_completed,
flow_run_failed