Webhook Events

Retrieve a Webhook Event

Retrieve an existing Webhook Event.

get/v1/webhooks/events/{id}

Request

Path parameters

idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The ID for the resource being accessed.

Response

OK

object'WebhookEvent' required

The object’s type (WebhookEvent).

idstring uuid required

The Webhook Event ID.

created_atstring date-time required

The last date this Webhook Event was tried to be sent.

event_namestring required

The event name of this Webhook Event.

event_resource'company' | 'item' | 'payable' | 'payment_method' | 'receivable' | 'risk_report' | 'tax_form' | 'test' required

All the possible WebhookEvent types for the /v1/webhooks/events endpoint.

is_pausedboolean required

If set to true, Routable will not try to send this Webhook Event again.

is_successfulboolean required

Whether this Webhook Event was successfully sent.

last_attempt_atstring date-time

The last date this Webhook Event was tried to be sent.

last_statusinteger required

If this Webhook Event was sent, what was the HTTP Response Routable received back.

next_attempt_atstring date-time

The date this Webhook Event will be attempted to be sent again.

object_idstring required

The ID of the object associated with this Webhook Event.

triesinteger required

The number of attempts made to send this Webhook Event.

Changes

No recorded changes to this operation across all 2 revisions of this API.