Webhooks

Get Webhook

Changed on

Get a single webhook in an organization.

get/api/v1/webhooks/{id}

Request

  • Base URL: https://api.fordefi.com
  • URL: https://api.fordefi.com/api/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

ID of the webhook to get.

Response

Successful Response

idstring uuid required

The unique identifier of the object in the Fordefi platform.

created_atstring date-time required

The date and time when the object was created.

modified_atstring date-time required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

namestring required

The name of the webhook.

eventsWebhookEventType[] required

The events that will trigger notifications for this subscription.

urlstring uri required

The URL of the webhook endpoint.

last_successful_call_atstring date-time required

The last successful call time to the webhook.

first_failed_call_atstring date-time required

The first failed call time to the webhook.

state'active' | 'suspended' required
is_retries_suspendedboolean required

Whether retries suspended for this webhook.

Example response

{
  "name": "Main transaction processor",
  "created_by": {
    "name": "John Doe"
  }
}

Changes