GET
/
webhooks
/
{webhook_id}
/
events
List recent webhook deliveries
curl --request GET \
  --url https://api.godiligent.ai/webhooks/{webhook_id}/events \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "event_type": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "status_code": 204,
    "request": {
      "headers": {},
      "payload": {}
    },
    "response": {
      "headers": {},
      "body": {}
    }
  }
]

Endpoint

GET /webhooks/{webhook_id}/events Returns a list of recent webhook delivery attempts for the specified webhook. Results are sorted by most recent first.

Path Parameters

ParameterTypeRequiredDescription
webhook_idstringYesThe ID of the webhook to list deliveries for.

Response

Returns a JSON array of delivery objects. Each object contains:
FieldTypeDescription
idstringUnique identifier for the delivery event.
event_typestringThe type of event delivered.
timestampstringISO timestamp of when the delivery occurred.
status_codenumberHTTP status code returned by the webhook endpoint.
requestobjectThe request payload sent to the webhook.
responseobjectThe response returned by the webhook endpoint.

Example Responses

cdd_state_changed

{
  "id": "54ef493d-7672-4cd8-8080-599601e9609d",
  "event_type": "cdd_state_changed",
  "timestamp": "2025-07-31T02:51:34.155Z",
  "status_code": 500,
  "request": {
    "headers": {
      "Content-Type": "application/json",
      "User-Agent": "DiligentAI/1.0",
      "X-Webhook-Id": "df89eb16-4c6a-439f-b668-7cca0cd786fa",
      "X-Event-Id": "54ef493d-7672-4cd8-8080-599601e9609d",
      "X-Customer-Id": "69df5d81-2b74-4f42-a401-13eb96ba0619",
      "X-Target-type": "CDD",
      "X-Event-Name": "CDD_COMPLETED",
      "X-Signature": "sha256=..."
    },
    "payload": "<CDD object as JSON string>"
  },
  "response": {
    "body": "..."
  }
}
  • payload: The full CDD object as a JSON string. See the CDD Object documentation for details.
  • headers: All headers sent to your endpoint, including:
    • Content-Type: Always application/json
    • User-Agent: Sender identifier
    • X-Webhook-Id: Webhook unique ID
    • X-Event-Id: Event unique ID
    • X-Customer-Id: Authenticated customer ID
    • X-Target-type: Always CDD
    • X-Event-Name: Specific CDD event (e.g., CDD_COMPLETED)
    • X-Signature: HMAC signature for authenticity

monitoring_alert_fired

{
  "id": "f9e2b3a7-2b4c-4d7d-9a2f-7f7c6f7c6f7c",
  "event_type": "monitoring_alert_fired",
  "timestamp": "2025-07-31T05:12:03.123Z",
  "status_code": 200,
  "request": {
    "headers": {
      "Content-Type": "application/json",
      "User-Agent": "DiligentAI/1.0",
      "X-Webhook-Id": "df89eb16-4c6a-439f-b668-7cca0cd786fa",
      "X-Event-Id": "f9e2b3a7-2b4c-4d7d-9a2f-7f7c6f7c6f7c",
      "X-Customer-Id": "69df5d81-2b74-4f42-a401-13eb96ba0619",
      "X-Target-type": "ALERT",
      "X-Event-Name": "MONITORING_ALERT_FIRED",
      "X-Signature": "sha256=..."
    },
    "payload": {
      "alert_id": "alrt_01HZY9V7FZJQ3K0KZP1YQ9E5X2",
      "monitoring_id": "mon_01HZY9V7FZJQ3K0KZP1YQ9E5X2",
      "type": "FRAUD",
      "details": {
        "reason": "Suspicious activity detected",
        "triggered_at": "2025-07-31T05:12:03.123Z"
      }
    }
  },
  "response": {
    "body": "ok"
  }
}
  • payload: The alert object, with all relevant fields for the alert event.
  • headers: Same structure as above, with X-Target-type as ALERT and X-Event-Name as MONITORING_ALERT_FIRED.

Errors

500 Internal Server Error

Unexpected error occurred.
{
  "error": "Internal server error"
}

Authentication

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

Authorizations

X-API-KEY
string
header
required

Path Parameters

webhook_id
string
required

Webhook ID to filter deliveries.

Response

200 - application/json

List of recent webhook delivery events.

The response is of type object[].