v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Webhook endpoints

Get a webhook endpoint

Retrieves a webhook endpoint by its id. Only endpoints matching the live or test mode of the API key are visible; deleted endpoints return a 404 Not Found error. secret is always null outside creation.

get/webhook_endpoints/{id}

Path parameters

idstring required

The id of the webhook endpoint to retrieve.

Response

The webhook endpoint. secret is always null outside creation.

idstring required

Unique identifier of the webhook endpoint.

object'webhook_endpoint' required

Type of the object. Always webhook_endpoint.

created_atstring date-time required

ISO 8601 timestamp of when the webhook endpoint was created.

descriptionstring nullable required

Optional free-text description of the endpoint.

enabled_eventsstring[] required

Event types that trigger a notification to this endpoint.

mode'test' | 'live' required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

namestring nullable required

Optional name to identify the endpoint.

secretstring nullable required

Secret used to verify the signature of the webhooks sent to the endpoint. Only returned when the endpoint is created; null in every other response.

status'disabled' | 'enabled' required

Whether the endpoint currently receives event notifications.

urlstring required

HTTPS URL that receives the event notifications.

Example response

{
  "id": "we_M6yrvOepCe3Rqp8B",
  "created_at": "2021-05-17T17:04:10.284Z",
  "description": "Webhook endpoint for payment events.",
  "enabled_events": [
    "link.credentials_changed"
  ],
  "mode": "live",
  "name": "My webhook endpoint",
  "secret": "whsec_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ",
  "status": "enabled",
  "url": "https://my.webhook.endpoint"
}