curl --request POST \
--url https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/', 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://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_version": "2026-07-01",
"created_at": "2025-06-15T10:00:00Z",
"description": "Production webhook endpoint",
"event_types": [
"recall",
"adverse_report.threshold_alert"
],
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"is_active": true,
"metadata": {
"order_id": "6735"
},
"signing_secret": "whsec_12...",
"updated_at": "2025-08-01T14:30:00Z",
"url": "https://example.com/webhooks/closient"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}Resume a paused webhook endpoint
Resume deliveries on an endpoint previously paused via POST /{endpoint_id}/pause/. Returns 422 if the endpoint is not currently paused (for example, if it was auto-disabled for delivery failures — re-activate it via PATCH with is_active: true once the underlying issue is fixed).
curl --request POST \
--url https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/', 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://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/resume/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_version": "2026-07-01",
"created_at": "2025-06-15T10:00:00Z",
"description": "Production webhook endpoint",
"event_types": [
"recall",
"adverse_report.threshold_alert"
],
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"is_active": true,
"metadata": {
"order_id": "6735"
},
"signing_secret": "whsec_12...",
"updated_at": "2025-08-01T14:30:00Z",
"url": "https://example.com/webhooks/closient"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}Authorizations
Path Parameters
UUID of the webhook endpoint. Returned as the id field on every endpoint response.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Response
OK
A webhook endpoint as read from the API.
Returned by GET /webhooks/endpoints/{endpoint_id}/, the list view,
and the rotate-secret/test endpoints. signing_secret is masked
except on the initial create response and on the rotate-secret
response — see :data:_SIGNING_SECRET_READ_DESC.
UUID identifier of the endpoint. Use this in path params and the deliveries-list endpoint_id filter.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Target URL the webhook payload will be POSTed to. HTTPS is required in production; http:// is accepted only by the local development server. Maximum 2048 characters. The request body is the raw event JSON; the signature lives in the X-Closient-Signature header (see signing_secret for the verification recipe).
2048HMAC-SHA256 signing secret for verifying the X-Closient-Signature header on inbound deliveries. Returned in full only on creation and rotation; subsequent GET/LIST responses return a masked form (<first-8-chars>...). Verification recipe: compute HMAC-SHA256(secret, f"{timestamp}.{raw_body}") where timestamp is the t= portion of the header, then hmac.compare_digest against the v1= portion. Reject if the timestamp is older than 5 minutes (replay protection). During a 24-hour rotation grace period the header carries an additional v1old= signature using the prior secret — accept either.
Whether this endpoint should receive deliveries. false pauses delivery without deleting historical records or losing the signing secret — useful while debugging a customer-side outage. New events are not enqueued for inactive endpoints.
Envelope version this endpoint receives. Pinned when the endpoint is created and never moved by Closient — shipping a new envelope version does not change what an existing endpoint gets, so an integration can keep running untouched indefinitely. PATCH this field when your parser is ready for a newer shape. v1 is the pre-catalog envelope (event_type / version / event_id / timestamp / data); 2026-07-01 is the current CloudEvents-shaped envelope (type / specversion / id / time / source / data) and additionally carries the cursor used for replay-on-reconnect.
v1, 2026-07-01 Derived lifecycle state. active mirrors is_active=true; paused is a self-serve, resumable pause (POST .../pause/ / .../resume/); disabled covers both a deletion and an automatic disable after a sustained 100% delivery failure rate — neither is resumable through the resume action. Read-only: set indirectly via is_active or the pause/resume actions, never written directly.
active, paused, disabled Server-side ISO 8601 timestamp (UTC) of when the resource was first persisted.
Server-side ISO 8601 timestamp (UTC) of the resource's last modification.
Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.
Show child attributes
Show child attributes
Optional human-readable label for this endpoint. Surfaced in the brand portal's webhooks list alongside the URL — useful when a single account has separate staging / production endpoints. Maximum 255 characters. Has no effect on delivery.
255Event types this endpoint subscribes to, drawn from the catalog at GET /webhooks/event-types/. Two forms are accepted: a full wire value (recall.opened) or a domain prefix (recall), which subscribes to every event in that domain including ones added after you subscribe — the recommended form for safety-critical domains. Values outside the catalog are rejected with 422 rather than silently accepted, so a typo cannot leave you subscribed to nothing. An empty list means every event type (fail-open); use is_active=false to pause delivery instead.
Deliver only events that reference at least one of these GTINs. Accepts GTIN-8/12/13/14 in any digit-count and normalizes to GTIN-14 (apps.core.types.gtin.GTIN). Backed by an indexed lookup table, so this scales to very large lists (100,000+ GTINs) without a per-event table scan. Empty list = no restriction (all GTINs).
Deliver only events whose product GTIN's company-prefix segment is one of these GS1 Company Prefixes (4-12 digits). Empty list = no restriction (all prefixes). Note: matched against the GS1-13/14 numbering alignment; a GTIN whose native form is UPC-A (GTIN-12) may not match its equivalent U.P.C. Company Prefix here — use the gtins filter for exact control in that case.
Deliver only events tagged with one of these ISO 3166-1 alpha-2 jurisdiction codes (e.g. US, CA). Empty list = no restriction (all jurisdictions).
Deliver only events for products in one of these 8-digit GS1 Global Product Classification brick codes. Empty list = no restriction (all categories).
Deliver only recall events whose recall is currently in one of these lifecycle statuses. Empty list = no restriction (all statuses).
A recall's lifecycle status, for the lifecycle_statuses filter dimension (C-4812).
Mirrors :class:apps.compliance.models.RecallEvent.LifecycleStatus.
PUBLISHED, AMENDED, CLOSED, RETRACTED