Sign in

v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-15152735.4 KB
webhooks

getConfigs

Search Webhook Client Configs

get/v1/webhooks/configs

Query parameters

eventNamestring

Filter configurations by event Name

Response

Success - configs loaded with success. Empty array if org has configs.

idstring
namestring required
eventNamestring required
urlstring
creationTimestring

creation timestamp

httpMethod'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'
enabledboolean
enableStaticIPboolean
protectedboolean

When true, indicates this webhook configuration is protected and should not be modified without explicit intent.

status'active' | 'inactive' | 'incomplete'
jsonataExpressionstring

JSONata expression to transform the payload

deliveryMode'json_base64' | 'binary_multipart'

Controls how file data is delivered to the endpoint. Only relevant when the webhook is triggered by a file event. Absent for non-file-event webhooks.

_manifeststring[]

Manifest ID used to create/update the webhook resource

signingSecretstring

Per-webhook signing secret following the Standard Webhooks specification. Only returned once during webhook creation. Use this secret to verify webhook signatures using the webhook-id, webhook-timestamp, and webhook-signature headers.

Example response

[
  {
    "eventName": "CustomerRequest_Created",
    "url": "https://my-partner-service.api.com",
    "httpMethod": "POST",
    "enabled": true,
    "auth": {
      "authType": "BASIC",
      "basicAuthConfig": {
        "username": "secretUsername",
        "password": "secret7825@!"
      }
    },
    "filter": {
      "keyToFilter": "customer_request.productId",
      "supportedValues": [
        "2324245",
        "5253642"
      ]
    }
  }
]