Webhook Endpoints Overview
Description
The Webhook Endpoints API group facilitates real-time event notifications for payment and payout activities using stablecoins. It allows developers to set up, retrieve, and update webhook endpoints, ensuring timely updates on transaction statuses with secure signature verification.
API Endpoints
- Create Webhook: Registers a new webhook endpoint with a specified URL.
- Get Webhook: Retrieves details of a specific webhook endpoint.
- Update Webhook: Updates the details of an existing webhook endpoint, such as its URL.
API Endpoint Reference
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/webhook_endpoints | Creates a new webhook endpoint. |
| GET | /v1/webhook_endpoints/:id | Retrieves details of a specific webhook. |
| PATCH | /v1/webhook_endpoints/:id | Updates an existing webhook endpoint. |
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the webhook endpoint (e.g., we_1ZbSVMF8KXuhmXpKPXkt). |
account_id | string | ID of the account associated with the webhook. |
url | string | The URL where webhook events will be sent. |
enabled_events | array | List of events enabled for this webhook (e.g., [] for none). |
description | string or null | Optional description of the webhook endpoint. |
secret | string | Secret key for verifying webhook signatures (e.g., whsec_67f8c3677abd4063da64ca3b11f1fe87). |
metadata | object | Additional metadata, if provided (e.g., {}). |
status | string | Current status of the webhook endpoint (e.g., enabled). |
created_at | timestamp | Time when the webhook endpoint was created. |
updated_at | timestamp | Time when the webhook endpoint was last updated. |
Status Enum
The status field indicates the current state of the webhook endpoint. Possible values are:
enabled: The webhook endpoint is active and receiving events.disabled: The webhook endpoint is inactive and not receiving events.