Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Webhooks

Get a single webhook event

Returns a full representation of a webhook event, including the data payload and delivery attempts.

Note: webhook events are currently retained for 30 days.

get/webhook/endpoints/{webhook_endpoint_id}/events/{webhook_event_id}

Path parameters

webhook_endpoint_idstring required
Example:3847dd41-8c90-499a-ac6e-10a027dd231f
webhook_event_idstring required
Example:ff95f020-8ef9-409d-bff6-8489e880359c

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

Success

created_atstring date-time required
updated_atstring date-time required
idstring uuid required
webhook_endpoint_idstring uuid required
type'test' | 'utility_credential_verified' | 'utility_credential_rejected' | 'utility_credential_revoked' | 'utility_credential_verification_error' | 'utility_accounts_discovered' | 'utility_accounts_discovery_error' | 'new_utility_statement_available' required
sandboxedboolean required
deliveredboolean required
dataobject

Original data payload of the webhook event. See webhook events for schema details.

Example response

{
  "id": "3847dd41-8c90-499a-ac6e-10a027dd231f",
  "webhook_endpoint_id": "3847dd41-8c90-499a-ac6e-10a027dd231f",
  "delivered": true,
  "delivery_attempts": [
    {
      "response_body": "{\\\"message\\\":\\\"ok\\\"}",
      "response_status_code": 200,
      "webhook_event_id": "3847dd41-8c90-499a-ac6e-10a027dd231f"
    }
  ]
}