Update a Webhook

PATCH/webhooks/{webhookId}

This endpoint allows API users to update a webhook.

Path Parameters

webhookIdstringrequired

Body application/json

idstring<uuid>

Webhook Identifier

external_idstringrequired

A unique id specified by API caller to avoid duplication API request

event_type"document_update" | "sender_update" | "transfer_update" | "payment_update" | "entity_anonymisation_event"required

Specify which event this webhook URL will handle.

notification_urlstring<uri>required

The URL to which event notification data will be POSTed.

public_keystring

The URL to which event notification data will be POSTed.

headersobject

Headers to be included in the notification request.

Show headers properties
keystring

Header name

valuestring

Header value

Response

OK

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X PATCH "https://api.uat.triple-a.io/api/fiat-payout/v1/webhooks/<webhookId>" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "id": "00000000-0000-0000-0000-000000000000",
  "external_id": "string",
  "event_type": "document_update",
  "notification_url": "string",
  "public_key": "string",
  "headers": {
    "key": "content-type",
    "value": "application/json"
  }
}'
Response
(no body)