Webhook

idstring<uuid>required

applicationIdstring<uuid>required

activebooleanrequired

endpointstringrequired

labelstringrequired

Possible values: <= 50 characters

numberOfErrorsintegerrequired

Operational failure counter; it is not a total count of every failed log. Inspect delivery logs and performance for unresolved failures.

authenticationProtocolAuthenticationProtocolrequired

Authentication of the receiving webhook endpoint, distinct from the Hub client x-api-key. Configure protocol credentials through webhook headers; NoAuthentication uses no receiver authentication; BasicAuthentication uses username/password, JWT uses a bearer token, Oauth20 obtains a token, and Chatt2MeForSalesforce uses the configured Salesforce integration. Use the documented X-Basic-, X-JWT-Token or X-OAuth- configuration headers. New configuration normalizes generated Authorization; supplying a manual Authorization header does not override the selected protocol. Salesforce rejects Authorization and X-OAuth-* with RESERVED_SALESFORCE_AUTH_HEADER.

Possible values: [NoAuthentication, Oauth20, BasicAuthentication, JWT, Chatt2MeForSalesforce]

requiresSignaturebooleanrequired

secretHintstringnullable

Last six characters of the signing secret when signature verification is enabled

secretstringnullable

Full signing secret returned only when enabling signature or immediately after create or redefine

isVerifiedbooleanrequired

verifiedAtstring<date-time>nullable

createdDatestring<date-time>required

lastModifiedDatestring<date-time>required

avgResponseTimeMsnumbernullable

Current stored average delivery latency in milliseconds; null before a sample is available.

headers object[]

Nondeleted receiver headers. Secret values for X-Basic-Password, X-JWT-Token, X-OAuth-Client-Secret and X-OAuth-Access-Token are omitted from responses.

Array [

keystringrequired

Possible values: non-empty and <= 255 characters

valuestringrequired

Possible values: non-empty and <= 255 characters

]

Webhook

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": true,
  "endpoint": "string",
  "label": "string",
  "numberOfErrors": 0,
  "authenticationProtocol": "NoAuthentication",
  "requiresSignature": true,
  "secretHint": "string",
  "secret": "string",
  "isVerified": true,
  "verifiedAt": "2024-07-29T15:51:28.071Z",
  "createdDate": "2024-07-29T15:51:28.071Z",
  "lastModifiedDate": "2024-07-29T15:51:28.071Z",
  "avgResponseTimeMs": 0,
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}