Webhooks
Référence de l'API pour Webhooks : chaque handler avec ses champs et un exemple.
Dernière mise à jour :
webhook-subscriber: detail
Récupérer un webhook
Renvoie un webhook par son identifiant, avec URL, sélection d’événements et échecs de livraison. Le secret de signature n’est jamais renvoyé.
- Scope requis:
webhooks:read - Endpoint:
POST /api/query
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
string (uuid) | oui |
Exemple de requête
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:webhook-subscriber:detail",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
webhook-subscriber: list
Lister les webhooks
Renvoie une liste filtrée et paginée de webhooks, avec URL, sélection d’événements, état actif et échecs de livraison. Le secret de signature n’est jamais renvoyé.
- Scope requis:
webhooks:read - Endpoint:
POST /api/query
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
cursor |
string | non | Position issue de nextCursor de la page précédente. |
limit |
integer | non | Lignes par page, 50 par défaut, au maximum 200. |
search |
string | non | Recherche plein texte dans les champs interrogeables. |
sort |
string | non | Champ servant au tri. |
sortDirection |
“asc” | “desc” | non | asc ou desc. |
offset |
integer | non | Nombre de lignes à ignorer. Pour paginer, préfère cursor. |
totalCount |
boolean | non | Avec true, tu reçois aussi total, le nombre de lignes correspondantes. |
includeDeleted |
boolean | non | Avec true, les lignes supprimées sont incluses. Uniquement pour les entités avec suppression logique. |
onlyDeleted |
boolean | non | Avec true, seules les lignes supprimées sont renvoyées. Uniquement pour les entités avec suppression logique, pas avec includeDeleted. |
filter |
object | non | Un filtre de champ avec field, op et value. op est l’un de eq, ne, lt, gt, lte, gte, in. |
filter.field |
string | oui | |
filter.op |
“eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” | oui | |
filter.value |
any | oui | |
filters |
array of object | non | Plusieurs filtres de champ, chacun avec field, op et value. op est l’un de eq, ne, lt, gt, lte, gte, in. |
namedFilter |
string | non | Nom d’un filtre prédéfini de l’entité, par exemple une file de travail. |
aggregate |
object | non | Renvoie des valeurs agrégées au lieu de lignes. |
aggregate.groupBy |
string | non | |
aggregate.measures |
array of object | non |
Exemple de requête
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:webhook-subscriber:list",
"payload": {}
}'
Exemple de réponse
Statut : 200
{
"data": {
"nextCursor": null,
"rows": [
{
"id": "00000000-0000-4000-8000-000000000001",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 1,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"url": "https://93.184.216.34/hook",
"description": null,
"events": [
"incident.created"
],
"active": true,
"failureCount": 0,
"lastDeliveryAt": null,
"lastFailureAt": null,
"lastFailureReason": null
}
]
}
}
webhook-subscriber: create
Créer un webhook
Enregistre une adresse HTTPS qui reçoit des événements webhook signés et renvoie une seule fois son secret de signature.
- Scope requis:
webhooks:write - Endpoint:
POST /api/write
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
url |
string (uri) | oui | URL |
description |
string | non | Nom |
events |
array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” | non | Événements |
Exemple de requête
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:webhook-subscriber:create",
"payload": {
"url": "https://93.184.216.34/hook",
"events": [
"incident.created"
]
}
}'
Exemple de réponse
Statut : 200
{
"isSuccess": true,
"data": {
"id": "00000000-0000-4000-8000-000000000001",
"secret": "REDACTED"
}
}
webhook-subscriber: delete
Supprimer un webhook
Supprime définitivement un webhook, de sorte que son adresse ne reçoit plus d’événements.
- Scope requis:
webhooks:write - Endpoint:
POST /api/write
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
string (uuid) | oui |
Exemple de requête
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:webhook-subscriber:delete",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
webhook-subscriber: reactivate
Réactiver un webhook
Réactive un webhook désactivé et remet son compteur d’échecs à zéro.
- Scope requis:
webhooks:write - Endpoint:
POST /api/write
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
string (uuid) | oui |
Exemple de requête
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:webhook-subscriber:reactivate",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
webhook-subscriber: rotate-secret
Renouveler le secret d’un webhook
Remplace le secret de signature d’un webhook et renvoie une seule fois le nouveau secret. L’ancien est invalide immédiatement.
- Scope requis:
webhooks:write - Endpoint:
POST /api/write
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
version |
number | non |
Exemple de requête
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:webhook-subscriber:rotate-secret",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1
}
}'
webhook-subscriber: update
Modifier un webhook
Modifie l’URL, la description ou la sélection d’événements d’un webhook.
- Scope requis:
webhooks:write - Endpoint:
POST /api/write
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
string (uuid) | oui | |
version |
number | oui | |
changes |
object | oui | |
changes.url |
string (uri) | non | URL |
changes.description |
string | null | non | Nom |
changes.events |
array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” | non | Événements |
Exemple de requête
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:webhook-subscriber:update",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1,
"changes": {
"url": "https://example.com",
"description": "text",
"events": [
"incident.created"
]
}
}
}'