API reference / Webhooks

patch/v2/webhook-endpoints/{id}

Update an endpoint

Operation
updateWebhookEndpoint
Authentication
API key

Set `active: true` to re-enable an endpoint that repeated failures switched off; doing so clears the failure count.

Request

Parameters

idpathrequiredstring

Body

urlstring

HTTPS required outside development. A delivery carries an applicant’s details and the outcome of their application.

descriptionstring
eventsstring[]
activeboolean

Re-enabling clears the failure count, so one failure does not re-disable it.

Responses

200Updated.
endpointWebhookEndpointrequired
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403The key is valid but lacks the scope, or it asked for a scope it does not itself hold.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X PATCH https://api.haavisa.com/v2/webhook-endpoints/<id> \
  -H "Authorization: Bearer $HAAVISA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

More in Webhooks

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.