Patch a Webhook Registration
Use this endpoint to update one or more fields of a webhook registration. Only the fields present in the request body are changed. Sending eventTypes as null clears the filter so the registration receives every event type. Only registrations belonging to the caller’s tenant can be patched.
Use the X-Idempotency header for guaranteed deduplication.
Autorizações
JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.
Cabeçalhos
Required idempotency key for safe retries. Use a UUID v4 or unique business identifier. If the same key is sent again and the original request was already processed, the cached response is returned.
See Retries and idempotency for details.
255Parâmetros de caminho
The unique identifier of the webhook registration to patch.
Corpo
Only the fields present in the request are updated. Sending eventTypes as null clears the filter so the registration receives every event type.
A human-readable name for the registration.
"Operations webhook"
The endpoint that receives event deliveries. Must be an HTTPS URL.
^https://"https://hooks.example.com/transfer-events"
Whether the registration is active.
true
The event types this endpoint subscribes to. Send null to clear the filter and receive every event type.
64Resposta
Indicates that the webhook registration was updated.
Repeated calls with the same X-Idempotency key replay the cached response.
See Retries and idempotency for more details.
The unique identifier of the webhook registration.
"550e8400-e29b-41d4-a716-446655440000"
The human-readable name of the registration.
"Operations webhook"
The HTTPS endpoint that receives event deliveries.
"https://hooks.example.com/transfer-events"
Whether the registration is active.
true
The timestamp when the registration was created.
"2026-02-01T15:30:00Z"
The timestamp of the last update.
"2026-02-01T15:30:00Z"
The event types this endpoint subscribes to. Absent when the registration receives every event type.