Active Subscriptions

GET

api

business

webhooks

curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/webhooks \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-stage.ugift.me/api/v1/business/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.ugift.me/api/v1/business/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.ugift.me/api/v1/business/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.ugift.me/api/v1/business/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "_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

Show child attributes

createdAt

string<date-time>

Example:

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

updatedAt

string<date-time>

Example:

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

Active Subscriptions

curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/webhooks \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-stage.ugift.me/api/v1/business/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.ugift.me/api/v1/business/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.ugift.me/api/v1/business/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.ugift.me/api/v1/business/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "_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"
  }
]

Authentication

Product Catalog

Orders & Dispatch

Financials

Webhooks

Outbound webhook events

Authorizations

Response