Disable or enable destination

PATCH https://api.invunion.com/api/v1/webhook-endpoints/:id Console / Firebase only Markdown

Update a webhook destination, including enable and disable.

Partial update. At least one field is required. active false disables the destination. active true clears the disabled timestamp and resets consecutive failures. eventTypes must be a non-empty subset of the catalog.

This route is console / Firebase only for now. Tenant API keys are not accepted.

See also

  • Webhooks . Events you can subscribe to and the JSON posted to your URL.

Path parameters

NameTypeRequired
id

Webhook destination UUID.

Example: 4e2deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

string

No maximum

Required

Body parameters

NameTypeRequired
active

If false, disable the destination. If true, enable it again.

Allowed valuestruefalse
boolean
Optional
url

HTTPS URL. Private hosts and URLs with credentials are rejected.

Example: https://hooks.leonescars.example/invunion

string

Max 2048

Optional
description

Optional label.

Example: Leones Cars operations

string

Max 255

Optional
eventTypes

Event types to deliver. Non-empty subset of the catalog.

array
Optional
Allowed valuestransaction.createdinvoice.createdinvoice.updatedinvoice.paidinvoice.partially_paidmatch.createdmatch.suggestedmatch.confirmedmatch.rejectedmatch.cancelledbank.connectedbank.disconnectedsync.completedsync.failed

Errors

This operation can return the following errors in addition to generic HTTP failures.

Error HTTP code Description
Missing Bearer token 401 The Authorization header is missing or is not a Bearer token.
Invalid token 401 Webhook destinations and deliveries are console-only. Send a Firebase ID token. Tenant API keys are not accepted on these routes.
Too many requests, please try again later 429 Wait and retry. The Retry-After header is the number of seconds to wait.
At least one field is required 400 The body was empty.
Webhook URL must use a public host 400 The URL is not a public HTTP or HTTPS host. Other URL checks return a similar message.
Webhook endpoint not found 404 No destination with this UUID exists in the authenticated tenant.
Internal server error 500 Unexpected server error. The JSON body includes correlationId. Retry with backoff.
Previous: Resend webhook