Naar de inhoud

API-documentatie

v1.0.0

Webhook aanmaken

POST/api/v1/webhooks

scope: webhooks:managegratis

Een https-URL en de events die u wilt ontvangen. Het geheim voor de handtekening staat alleen in dit antwoord.

Body

Body
NaamTypeOmschrijving
urlverplicht

Openbare https-URL

stringOpenbare https-URL
eventsverplicht

Events om te ontvangen

enum[]Events om te ontvangen case.created · case.status_changed · report.published · report.processed · value.corrected · value.conflict · portfolio.hit · auction.linked
enabled

Webhook aan of uit

booleanWebhook aan of uit

Antwoord · HTTP 201

Antwoord · HTTP 201

Antwoord · HTTP 201
NaamTypeOmschrijving
dataverplichtobject
data.secretverplichtstring

Antwoord · HTTP 422

Validation error

Antwoord · HTTP 422

Antwoord · HTTP 422
NaamTypeOmschrijving
errorverplichtobject
error.codeverplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.messageverplicht

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

De velden van het antwoord staan in openapi.json. Hoe elke waarde met bron is opgebouwd, leest u bij Gegevens en brondocumenten