Créer un webhook utilisateur

POST

https://workflow-manager/api/users/:userId/webhooks

POST

/api/users/:userId/webhooks

curl -X POST https://workflow-manager/api/users/userId/webhooks \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "endpointUrl": "https://my-company.com/BE3jQ2obAZFJgdZCADnfbnnx",
  "notifiedEvents": [
    "commentCreated",
    "recipientRefused",
    "recipientFinished",
    "workflowStarted",
    "workflowStopped",
    "coManagerRemoved",
    "coManagerAdded",
    "workflowFinished"
  ]
}'

{
  "created": 1782821303814,
  "endpointUrl": "https://my-company.com/BE3jQ2obAZFJgdZCADnfbnnx",
  "id": "wbh_7emNNL9g9nw7hV23NzQyZrog",
  "notifiedEvents": [
    "commentCreated",
    "recipientRefused",
    "recipientFinished",
    "workflowStarted",
    "workflowStopped",
    "workflowFinished",
    "coManagerRemoved",
    "coManagerAdded"
  ],
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821303814,
  "customHeaders": {},
  "userId": "usr_JCwoLDH99mzqizvqyAYJx4gV"
}

Crée un webhook recevant les événements des parapheurs d’un utilisateur donné.

Rôle requis

developer (ses propres ressources uniquement).

Crée un webhook recevant les événements des parapheurs d'un utilisateur donné. <Note title="Rôle requis"> `developer` (ses propres ressources uniquement). </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de chemin

userIdstringRequis

L'identifiant de l'utilisateur.

Requête

This endpoint expects an object.

endpointUrlstringRequis

L'URL de l'endpoint du webhook.

notifiedEventslist of stringsRequis

Les types d’événements notifiés au webhook.

Réponse

Créer un webhook utilisateur

createdlong

La date de création de l’entité.

endpointUrlstring

L'URL de l'endpoint du webhook.

idstring

L'identifiant du webhook.

notifiedEventslist of strings

Les types d’événements notifiés au webhook.

tenantIdstring

L'identifiant du tenant auquel appartient le webhook.

updatedlong

La date de dernière modification de l’entité.

customHeadersmap from strings to anyOptionnel

Une liste d’en-têtes personnalisés, chacun composé d’une clé et d’une valeur.

userIdstringOptionnel

L'identifiant de l'utilisateur auquel appartient le webhook, dans le cas d'un webhook utilisateur.

Erreurs

400

Bad Request Error

403

Forbidden Error