Skip to main content
GET
/
api
/
v1
/
zapier
/
status
Check Integration Status
curl --request GET \
  --url https://api.ugift.me/api/v1/zapier/status \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "configured": true,
  "businessId": "business_123456789",
  "webhookUrl": "https://hooks.zapier.com/hooks/catch/123456/abc123/",
  "events": [
    "voucher.sent",
    "voucher.redeemed",
    "payment.failed",
    "wallet.funded"
  ],
  "isActive": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "message": "No webhook integration configured"
}

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

Response

Integration status retrieved successfully

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
configured
boolean
required

Whether webhook integration is configured

Example:

true

​
businessId
string
required

The business ID associated with the API key

Example:

"business_123456789"

​
webhookUrl
string<uri>

The configured webhook URL (if configured)

Example:

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

​
events
string[]

List of subscribed event types

Example:
[
  "voucher.sent",
  "voucher.redeemed",
  "payment.failed",
  "wallet.funded"
]
​
isActive
boolean

Whether the integration is currently active

Example:

true

​
createdAt
string<date-time>

When the integration was created

Example:

"2024-01-15T10:30:00.000Z"

​
message
string

Additional information about the integration status

Example:

"No webhook integration configured"