Skip to main content
PUT
Update a webhook endpoint

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Path Parameters

id
string<uuid>
required
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json
events
string[]
required

Events to subscribe. webhook.test is not subscribable.

Minimum array length: 1
Example:
name
string
required
Maximum string length: 120
Pattern: \S
Example:

"ERP"

url
string
required

Public HTTPS URL. Private and internal addresses are refused.

Maximum string length: 2048
Pattern: \S
Example:

"https://erp.example.com/gamecart"

enabled
boolean
Example:

true

Response

The endpoint.

An HTTPS endpoint that receives signed order events.

createdAt
string<date-time>
Example:

"2026-09-25T13:05:00.000Z"

enabled
boolean

Disabled endpoints receive nothing, including test deliveries.

events
string[]

Subscribed events.

Example:
id
string<uuid>
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

name
string
Example:

"ERP"

secret
string

Signing secret. Returned only on create and on secret rotation; store it now.

Example:

"gcwhsec_7vJt0mX2..."

secretFingerprint
string

Last characters of the signing secret, to tell secrets apart.

Example:

"******Xy12ab"

updatedAt
string<date-time>
Example:

"2026-09-25T13:05:00.000Z"

url
string
Example:

"https://erp.example.com/gamecart"