Create webhook endpoint

Create a new webhook endpoint to receive event notifications

POST /api/public/v1/webhooks

Create webhook endpoint

cURL

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "store_abc123",
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "eventTypes": [
    "order/paid"
  ],
  "description": "Zapier integration"
}
'

200

{
  "id": "wh_abc123",
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "secret": "whsec_abc123...",
  "eventTypes": [
    "order/paid"
  ],
  "enabled": true,
  "createdAt": "2024-01-01T12:00:00.000Z"
}

Authorizations

Authorization · string · header · required

Enter your API key as: Bearer your-api-key

Body

application/json

storeId · string · required

url · string<uri> · required

eventTypes · string[] · required

Minimum array length: 1

description · string

Response

200

application/json

Successful response