Skip to main content
GET
/
api
/
v1
/
business
/
webhooks
Active Subscriptions
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/webhooks \
  --header 'X-API-Key: <api-key>'
[
  {
    "_id": "65d3f4a5b6c7d89012345678",
    "businessId": "507f1f77bcf86cd799439011",
    "url": "https://hooks.example.com/ugiftme/inbound",
    "events": [
      "order.succeeded",
      "wallet.updated"
    ],
    "isActive": true,
    "description": "Production order notifications",
    "lastUsed": "2025-04-11T08:15:00.000Z",
    "deliveryStats": {
      "success": 142,
      "failed": 2
    },
    "createdAt": "2025-03-01T10:00:00.000Z",
    "updatedAt": "2025-04-11T08:15:00.000Z"
  }
]

Authorizations

​
X-API-Key
string
header
required

Your UGiftMe API key for authentication.

Format: Secure API key (e.g., <your-api-key>)

Required: All endpoints require this header

Example: X-API-Key: <your-api-key>

Response

Webhooks (secrets omitted)

​
_id
string
Example:

"65d3f4a5b6c7d89012345678"

​
businessId
string
Example:

"507f1f77bcf86cd799439011"

​
url
string<uri>
Example:

"https://hooks.example.com/ugiftme/inbound"

​
events
string[]
Example:
["order.succeeded", "wallet.updated"]
​
isActive
boolean
Example:

true

​
description
string
Example:

"Production order notifications"

​
lastUsed
string<date-time>
Example:

"2025-04-11T08:15:00.000Z"

​
deliveryStats
object
​
createdAt
string<date-time>
Example:

"2025-03-01T10:00:00.000Z"

​
updatedAt
string<date-time>
Example:

"2025-04-11T08:15:00.000Z"