Référence de l’API : webhooks

Les webhooks sortants avertissent vos propres systèmes lorsqu’un événement se produit dans ProcessMind. Chaque envoi est une requête JSON POST signée avec le secret de votre webhook : l’en-tête X-ProcessMind-Signature contient sha256=<hex>, un HMAC-SHA256 calculé à partir du corps brut de la requête. Vérifiez la signature à partir des octets exacts reçus, avant d’analyser le JSON, et rejetez tout envoi dont la signature ne correspond pas. Chaque corps contient également un deliveryId, qui permet d’éliminer les doublons lorsque les envois sont effectués au moins une fois.

Lister les webhooks sortants

Point de terminaison : GET /v1/tenant/{tenantId}/webhooks

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid
limit	entier	requête	Non	Nombre maximal d’éléments à renvoyer
offset	entier	requête	Non	Nombre d’éléments à ignorer

Réponse (200) :

Liste des webhooks

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"url": "string",
		"events": [
			"process.created"
		],
		"description": "string",
		"isActive": true,
		"createdAt": "2024-03-15T16:30:00Z"
	}
]

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée

Créer un webhook sortant (le secret de signature n’est renvoyé qu’une fois)

Point de terminaison : POST /v1/tenant/{tenantId}/webhooks

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid

Corps de la requête :

{
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string"
}

Champ	Type	Obligatoire	Description
url	chaîne	Oui	Point de terminaison HTTPS public recevant les requêtes POST signées (les adresses privées ou de bouclage ne sont pas autorisées)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Oui	Événements qui déclenchent un envoi vers ce webhook
description	chaîne	Non	Description facultative Longueur maximale : 500

Réponse (201) :

Webhook créé (le secret de signature est inclus)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"secret": "string"
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Format : uuid
url	chaîne	Oui	Format : uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Oui
description	chaîne	Oui	Longueur maximale : 500
isActive	booléen	Oui	Valeur par défaut : true
createdAt	chaîne	Oui	Format : date-time
secret	chaîne	Oui	Secret de signature, renvoyé uniquement à la création

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, désactivée ou expirée

Obtenir un webhook sortant

Point de terminaison : GET /v1/tenant/{tenantId}/webhooks/{webhookId}

Authentification : Clé API limitée à l’environnement · portée read

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid
webhookId	chaîne	chemin	Oui	Format : uuid

Réponse (200) :

Webhook

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z"
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Format : uuid
url	chaîne	Oui	Format : uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Oui
description	chaîne	Oui	Longueur maximale : 500
isActive	booléen	Oui	Valeur par défaut : true
createdAt	chaîne	Oui	Format : date-time

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable

Modifier un webhook sortant

Point de terminaison : PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid
webhookId	chaîne	chemin	Oui	Format : uuid

Corps de la requête :

{
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true
}

Champ	Type	Obligatoire	Description
url	chaîne	Non	Point de terminaison HTTPS public recevant les requêtes POST signées
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Non	Événements qui déclenchent un envoi vers ce webhook
description	chaîne	Non	Description facultative Longueur maximale : 500
isActive	booléen	Non	Indique si le webhook est activé

Réponse (200) :

Webhook modifié

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z"
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Format : uuid
url	chaîne	Oui	Format : uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Oui
description	chaîne	Oui	Longueur maximale : 500
isActive	booléen	Oui	Valeur par défaut : true
createdAt	chaîne	Oui	Format : date-time

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable

Supprimer un webhook sortant

Point de terminaison : DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid
webhookId	chaîne	chemin	Oui	Format : uuid

Réponse (200) :

Webhook supprimé

{
	"deleted": true
}

Champ	Type	Obligatoire	Description
deleted	booléen	Oui

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable

Déclencher un envoi de test vers le webhook

Point de terminaison : POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

Authentification : Clé API limitée à l’environnement · portée write

Paramètres :

Nom	Type	Emplacement	Obligatoire	Description
tenantId	chaîne	chemin	Oui	Format : uuid
webhookId	chaîne	chemin	Oui	Format : uuid

Réponse (200) :

Envoi de test déclenché

{
	"message": "string"
}

Champ	Type	Obligatoire	Description
message	chaîne	Oui

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable