Skip to main content
POST
/
api
/
v1
/
business
/
webhooks
Create Webhook
curl --request POST \
  --url https://api-stage.ugift.me/api/v1/business/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "description": "<string>"
}
'
{
  "id": "65d3f4a5b6c7d89012345678",
  "url": "https://hooks.example.com/ugiftme/inbound",
  "events": [
    "order.succeeded",
    "wallet.updated"
  ],
  "secret": "a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcd"
}

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>

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Available options:
order.queued,
order.processing,
order.succeeded,
order.failed,
product.updated,
wallet.updated
​
description
string

Response

Created; secret is shown once

​
id
string
Example:

"65d3f4a5b6c7d89012345678"

​
url
string
Example:

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

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

Shown only at creation time; store securely.

Example:

"a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcd"