Webhooks

Create or update webhook endpoints

Create a new webhook endpoint or update an existing one. If an endpoint with the same URL already exists, it will be updated with the new event subscriptions.

post/webhooks

Request

Request body

endpoint_urlstring uri required

The HTTPS URL where webhook events will be sent. Must use HTTPS protocol.

Example request

{
  "endpoint_url": "https://example.com/webhooks/resolve",
  "events": {
    "invoice.created": true,
    "order.created": true,
    "customer.created": true,
    "customer.credit_decision_created": true,
    "payment.created": true,
    "payment.status_changed": true,
    "merchant.created": true,
    "merchant.underwriting_completed": true
  }
}

Response

Successful response with webhook endpoint subscriptions

idstring

Unique identifier for the webhook endpoint

merchant_idstring

The partner ID associated with this webhook endpoint

endpoint_urlstring uri

The HTTPS URL where webhook events will be sent

created_atstring date-time

When this webhook endpoint subscription was created

updated_atstring date-time

When this webhook endpoint subscription was last updated

Example response

[
  {
    "id": "whe_abc123def456",
    "merchant_id": "mer_xyz789",
    "endpoint_url": "https://example.com/webhooks/resolve",
    "topic": {
      "name": "invoice.created",
      "description": "Triggered when a new invoice record is created"
    },
    "created_at": "2021-05-20T09:23:53+00:00",
    "updated_at": "2021-05-20T09:23:53+00:00"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.