Webhooks API

Manage webhook endpoints programmatically.

Current implemented route family: api/v1/webhook-endpoints

The Webhook Endpoint object

{
  "id": "we_abc123",
  "object": "webhook_endpoint",
  "url": "https://yoursite.com/webhooks/ikawaari",
  "enabled_events": ["payment_intent.succeeded", "payment_intent.payment_failed"],
  "enabled": true
}

Endpoints

Method	Endpoint	Description
POST	/api/v1/webhook-endpoints	Create a webhook endpoint
GET	/api/v1/webhook-endpoints/{id}	Retrieve a webhook endpoint
GET	/api/v1/webhook-endpoints	List webhook endpoints
POST	/api/v1/webhook-endpoints/{id}	Update a webhook endpoint
POST	/api/v1/webhook-endpoints/{id}/rotate_secret	Rotate a webhook signing secret

Merchant dashboard APIs also expose additional webhook management operations under merchant route families, including test, replay, and attempts inspection.

Create a Webhook Endpoint

POST /api/v1/webhook-endpoints

Parameter	Type	Required	Description
url	string	No	URL that receives webhook events.
enabled_events	string[]	No	List of event types to subscribe to.

The create response also includes secret. Store it server-side: it is used to verify webhook signatures.

{
  "url": "https://yoursite.com/webhooks/ikawaari",
  "enabled_events": ["payment_intent.succeeded", "payment_intent.payment_failed"]
}

Update a Webhook Endpoint

POST /api/v1/webhook-endpoints/{id}

Parameter	Type	Required	Description
url	string	No	New webhook URL.
enabled_events	string[]	No	New subscribed event list.
enabled	boolean	No	Enables or disables the endpoint.