Webhooks

Update Webhook

Updates an existing webhook subscription (configuration stored in UGiftMe).

This does not change how you receive deliveries: UGiftMe still POSTs event payloads to your URL. Use PATCH to change the target URL, subscribed events, description, or pause/resume (isActive) without deleting and re-creating the webhook (the signing secret is unchanged).

Provide at least one of url, events, description, isActive. When updating events, the array must be non-empty and only contain allowed event types.

How to call — PATCH {server}/api/v1/business/webhooks/{id} with X-API-Key and a JSON body.

PATCH

api

business

webhooks

{id}

Update Webhook

curl --request PATCH \
  --url https://api-stage.ugift.me/api/v1/business/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://hooks.example.com/ugiftme/v2/inbound",
  "events": [
    "order.succeeded",
    "wallet.updated"
  ],
  "isActive": true
}
'

import requests

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

payload = {
    "url": "https://hooks.example.com/ugiftme/v2/inbound",
    "events": ["order.succeeded", "wallet.updated"],
    "isActive": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://hooks.example.com/ugiftme/v2/inbound',
    events: ['order.succeeded', 'wallet.updated'],
    isActive: true
  })
};

fetch('https://api-stage.ugift.me/api/v1/business/webhooks/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.example.com/ugiftme/v2/inbound',
    'events' => [
        'order.succeeded',
        'wallet.updated'
    ],
    'isActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-stage.ugift.me/api/v1/business/webhooks/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}"

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

{
  "message": "Webhook updated successfully",
  "webhook": {
    "_id": "65d3f4a5b6c7d89012345678",
    "businessId": "507f1f77bcf86cd799439011",
    "url": "https://hooks.example.com/ugiftme/v2/inbound",
    "events": [
      "order.succeeded",
      "wallet.updated"
    ],
    "isActive": true,
    "description": "Production order notifications",
    "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>

Path Parameters

string

required

Body

application/json

At least one property must be present. Omitted fields are left unchanged. The signing secret cannot be updated via this endpoint.

url

string<uri>

HTTPS (or HTTP) URL that will receive outbound POST deliveries.

events

enum<string>[]

Minimum array length: 1

Available options:

order.queued,

order.processing,

order.succeeded,

order.failed,

product.updated,

wallet.updated

description

string

isActive

boolean

When false, UGiftMe stops sending events to this URL until set back to true.

Response

Updated; signing secret is not returned

message

string

required

Example:

"Webhook updated successfully"

webhook

object

required

Webhook configuration without signing secret.

Show child attributes

Example:

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

Update Webhook

curl --request PATCH \
  --url https://api-stage.ugift.me/api/v1/business/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://hooks.example.com/ugiftme/v2/inbound",
  "events": [
    "order.succeeded",
    "wallet.updated"
  ],
  "isActive": true
}
'

import requests

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

payload = {
    "url": "https://hooks.example.com/ugiftme/v2/inbound",
    "events": ["order.succeeded", "wallet.updated"],
    "isActive": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://hooks.example.com/ugiftme/v2/inbound',
    events: ['order.succeeded', 'wallet.updated'],
    isActive: true
  })
};

fetch('https://api-stage.ugift.me/api/v1/business/webhooks/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.example.com/ugiftme/v2/inbound',
    'events' => [
        'order.succeeded',
        'wallet.updated'
    ],
    'isActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-stage.ugift.me/api/v1/business/webhooks/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.example.com/ugiftme/v2/inbound\",\n  \"events\": [\n    \"order.succeeded\",\n    \"wallet.updated\"\n  ],\n  \"isActive\": true\n}"

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

{
  "message": "Webhook updated successfully",
  "webhook": {
    "_id": "65d3f4a5b6c7d89012345678",
    "businessId": "507f1f77bcf86cd799439011",
    "url": "https://hooks.example.com/ugiftme/v2/inbound",
    "events": [
      "order.succeeded",
      "wallet.updated"
    ],
    "isActive": true,
    "description": "Production order notifications",
    "createdAt": "2025-03-01T10:00:00.000Z",
    "updatedAt": "2025-04-11T08:15:00.000Z"
  }
}

Authentication

Product Catalog

Orders & Dispatch

Financials

Webhooks

Outbound webhook events

Update Webhook

Authorizations

Path Parameters

Body

Response