Subscribe to an event

To subscribe to an event, you need to provide the type of action you want to monitor and the URL to which notifications will be sent. See the available event types page for the full list of supported actions.

Request

POST /webhooks

{
  "action": "payment_confirmed",
  "url": "https://example.com/webhook"
}

Response

{
  "date": "2024-01-15T10:00:00+00:00",
  "success": true,
  "data": {
    "id": "1",
    "action": "payment_confirmed",
    "url": "https://example.com/webhook",
    "createdAt": "2024-01-15T10:00:00+00:00"
  }
}

When the subscription is created successfully, a unique identifier (id) is returned that allows you to manage the webhook afterwards.