v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Webhook

Update an existing webhook.

put/webHooks/{webHookId}

Path parameters

webHookIdstring required

Identifier for the webhook.

Request body

activeboolean

Indicates if the webhook is active.

customerIdentifiersToBeEnrichedstring[]

List of customer identifiers enrichment available in the payload.

eventNamesstring[]

List of event names that trigger the webhook.

maxAllowedConnectionsinteger

Maximum allowed concurrent connections for this webhook.

methodTypestring

HTTP method used by the webhook. Example: POST, PUT, GET or DELETE.

namestring

Name of the webhook.

slaInSecondsinteger

Expected delivery time of the event notification in seconds. This is used to track notifications that took more time than the SLA set.

webHookHeadersstring[]

Headers sent with the webhook request.

webHookTypestring

Type of webhook, Example: HTTP

webHookUrlstring

URL where the webhook sends its requests.

Response

200

{"stackTrail":"paths:/webHooks/{webHookId}:put:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/webHooks/{webHookId}:put:responses:200:content:application/json:schema:properties:warnings","oasType":"schema","type":"unknown"}

Example response

{
  "data": {
    "attribution": {
      "createdOn": "2024-10-25T11:43:34.087+0000",
      "lastUpdatedOn": "2024-10-28T06:44:05.025+0000",
      "lastUpdatedBy": {
        "id": 75121810,
        "code": "test_123",
        "name": "test_123",
        "type": "TILL"
      },
      "createdBy": {
        "id": 75121810,
        "code": "test_123",
        "name": "test_123",
        "type": "TILL"
      }
    },
    "webHookId": "671b8466760af0000761b640",
    "name": "test_post_webhook_1234",
    "eventNames": [
      "loyaltyCustomerMerge"
    ],
    "webHookUrl": "http://eu.api.capillarytech.com",
    "webHookType": "HTTP",
    "methodType": "PUT",
    "webHookHeaders": {
      "Authorization": "Basic Q2FwaWxsYXJ5OklVTmhWVVQTROekl5",
      "Content-Type": "application/json"
    },
    "maxAllowedConnections": 10,
    "active": true,
    "slaInSeconds": 150,
    "consumerGroupId": "8fb2fdec-53ba-44de-bce9-82eedcb29026"
  }
}