Skip to main content
GET
/
webhooks
/
{webhook_id}
Get a webhook
curl --request GET \
  --url https://api.godiligent.ai/webhooks/{webhook_id} \
  --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/{webhook_id} Returns a single webhook, including its derived delivery status.

Path Parameters

ParameterTypeRequiredDescription
webhook_idstringYesThe ID of the webhook to retrieve.

Response

A webhook object. See List Webhooks for the field reference. The signing secret is never returned; has_secret indicates whether one is configured.
{
  "id": "df89eb16-4c6a-439f-b668-7cca0cd786fa",
  "webhook_url": "https://crm.example.com/diligent",
  "is_active": true,
  "has_secret": true,
  "status": "failing",
  "last_delivery_at": "2025-07-31T02:51:34.155Z",
  "last_delivery_status": 500,
  "events": ["cdd_state_changed", "alert_remediated"]
}

404 Not Found

No webhook with that ID exists for the authenticated customer.

Authentication

This endpoint requires authentication. You can only retrieve webhooks owned by the authenticated customer.

Authorizations

X-API-KEY
string
header
required

Path Parameters

webhook_id
string
required

ID of the webhook to retrieve.

Response

The requested webhook.

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