Skip to main content
POST
/
api
/
v1
/
zapier
/
subscribe
/
{eventType}
Subscribe to Webhook Event
curl --request POST \
  --url https://api.ugift.me/api/v1/zapier/subscribe/{eventType} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "webhookUrl": "https://hooks.zapier.com/hooks/catch/123456/abc123/"
}
'
{
  "success": true,
  "eventType": "voucher.sent",
  "subscribed": true,
  "webhookUrl": "https://hooks.zapier.com/hooks/catch/123456/abc123/",
  "businessId": "business_123456789"
}

Authorizations

​
X-API-Key
string
header
required

Your uGiftme business API key for authentication.

Format: UUID format (e.g., 6b4e22b2-c0a5-4c7a-888a-b38eac20b454) Required: All endpoints require this header Permissions: Must have business-level access with Zapier integration permissions

Example: X-API-Key: 6b4e22b2-c0a5-4c7a-888a-b38eac20b454

Path Parameters

​
eventType
enum<string>
required

The event type to subscribe to

Available options:
voucher.sent,
voucher.redeemed,
payment.failed,
wallet.funded

Body

application/json
​
webhookUrl
string<uri>
required

The Zapier webhook URL to receive events

Example:

"https://hooks.zapier.com/hooks/catch/123456/abc123/"

Response

Successfully subscribed to event

​
success
boolean
required

Indicates if the subscription was successful

Example:

true

​
eventType
string
required

The event type that was subscribed to

Example:

"voucher.sent"

​
subscribed
boolean
required

Whether the subscription was successful

Example:

true

​
webhookUrl
string<uri>
required

The webhook URL for the subscription

Example:

"https://hooks.zapier.com/hooks/catch/123456/abc123/"

​
businessId
string
required

The business ID associated with the subscription

Example:

"business_123456789"