Event subscriptions, their deliveries and their test.
List webhook subscriptions
GET/webhook-subscriptions
Scope : webhooks:ecrireManage webhook subscriptions and replay deliveries
Whole list by default; with page or limit, paginated (25 by default, 500 at most).
Parameters
Name
In
Type
Required
Description
page
query
integer
no
limit
query
integer
no
page
query
integer
no
Numéro de page, à partir de 1
limit
query
integer
no
Éléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions' \
-H "x-api-key: $RDV_TOKEN"
Responses
200 Success
401 Missing, unknown or expired token
403 Missing scope or right refused
404 Not found (or another organisation's)
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Subscribe to events
POST/webhook-subscriptions
Scope : webhooks:ecrireManage webhook subscriptions and replay deliveries
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.
Request body
`{url, events: [...], type_id?}` — le secret de signature n'est donné qu'ici
Scope : webhooks:ecrireManage webhook subscriptions and replay deliveries
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}/deliveries' \
-H "x-api-key: $RDV_TOKEN"
Responses
200 Success
401 Missing, unknown or expired token
403 Missing scope or right refused
404 Not found (or another organisation's)
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Send a test event
POST/webhook-subscriptions/{id}/test
Scope : webhooks:ecrireManage webhook subscriptions and replay deliveries
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
id
path
string (uuid)
yes
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Replay a delivery
POST/webhook-deliveries/{id}/replay
Scope : webhooks:ecrireManage webhook subscriptions and replay deliveries
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
id
path
string (uuid)
yes
La livraison
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.