API ReferenceChangelog
Log In
API Reference

Update a webhook

patch
https://api.pixop.com/api/v1/webhooks/

Updates the details of an existing webhook. To activate or deactivate a webhook, use the respective endpoints.

Path Params
uuid
required

The unique identifier for the object.

Body Params

Fields of a webhook that can be updated.

string
length between 1 and 47

A user-defined name to help identify and organize the webhook.

string
length between 1 and 255

A user-defined description providing context about the webhook’s purpose or usage.

string
length between 1 and 4096

A URL that must use HTTPS and point to a publicly reachable address. Only port 443 is allowed for HTTPS URLs. The following addresses are not allowed:

  • Loopback (e.g., 127.x.x.x, ::1)
  • Site-local (RFC1918) addresses (e.g., 10.x.x.x, 192.168.x.x, 172.16–31.x.x, IPv6 unique-local)
  • Link-local addresses (e.g., 169.254.x.x, fe80::/10)
  • Multicast addresses (e.g., 224.0.0.0–239.255.255.255, ff00::/8)

The server will parse the URL, resolve its host, and reject any internal or non-public address.

integer
1 to 1000

The maximum number of requests per second that Pixop will send to the webhook URL.
This rate limit is enforced to avoid overwhelming the receiving system.

integer
0 to 1440

The maximum total duration, in minutes, over which retry attempts will be made for a failed webhook event.
Once this threshold is reached, no further retries will be performed.

eventTypes
array of objects
length between 1 and 22
Defaults to null
eventTypes
Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated about 1 year ago