API-referentie: webhooks

Uitgaande webhooks melden gebeurtenissen binnen ProcessMind aan je eigen systemen. Elke levering is een JSON POST die met je webhookgeheim wordt ondertekend. De header X-ProcessMind-Signature bevat sha256=<hex>, een HMAC-SHA256 van de onbewerkte request body. Controleer de handtekening tegen exact de bytes die je hebt ontvangen, voordat je de JSON parseert, en wijs leveringen af waarvan de handtekening niet overeenkomt. Elke body bevat ook een deliveryId, waarmee je leveringen die minstens één keer worden afgeleverd kunt ontdubbelen.

Uitgaande webhooks weergeven

Endpoint: GET /v1/tenant/{tenantId}/webhooks

Authenticatie: API-sleutel voor tenant · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt teruggegeven
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met webhooks

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

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Een uitgaande webhook aanmaken (geeft het ondertekeningsgeheim één keer terug)

Endpoint: POST /v1/tenant/{tenantId}/webhooks

Authenticatie: API-sleutel voor tenant · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
url	string	Ja	Openbaar https-endpoint dat ondertekende POST-leveringen ontvangt, geen privé- of loopbackadressen
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ja	Gebeurtenissen die een levering naar deze webhook starten
description	string	Nee	Optionele beschrijving Maximale lengte: 500

Response (201):

Webhook aangemaakt, inclusief het ondertekeningsgeheim

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
url	string	Ja	Indeling: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ja
description	string	Ja	Maximale lengte: 500
isActive	boolean	Ja	Standaard: true
createdAt	string	Ja	Indeling: date-time
secret	string	Ja	Ondertekeningsgeheim, alleen hier teruggegeven bij het aanmaken

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Eén uitgaande webhook ophalen

Endpoint: GET /v1/tenant/{tenantId}/webhooks/{webhookId}

Authenticatie: API-sleutel voor tenant · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
webhookId	string	path	Ja	Indeling: uuid

Response (200):

Webhook

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
url	string	Ja	Indeling: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ja
description	string	Ja	Maximale lengte: 500
isActive	boolean	Ja	Standaard: true
createdAt	string	Ja	Indeling: date-time

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een uitgaande webhook bijwerken

Endpoint: PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

Authenticatie: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
webhookId	string	pad	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
url	string	Nee	Openbaar https-endpoint dat ondertekende POST-leveringen ontvangt
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Nee	Events die een levering naar deze webhook activeren
description	string	Nee	Optionele beschrijving Maximale lengte: 500
isActive	boolean	Nee	Of de webhook is ingeschakeld

Response (200):

Webhook bijgewerkt

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
url	string	Ja	Indeling: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ja
description	string	Ja	Maximale lengte: 500
isActive	boolean	Ja	Standaard: true
createdAt	string	Ja	Indeling: date-time

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een uitgaande webhook verwijderen

Endpoint: DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

Authenticatie: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
webhookId	string	pad	Ja	Indeling: uuid

Response (200):

Webhook verwijderd

{
	"deleted": true
}

Veld	Type	Verplicht	Beschrijving
deleted	boolean	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een testlevering naar de webhook starten

Endpoint: POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

Authenticatie: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
webhookId	string	pad	Ja	Indeling: uuid

Response (200):

Testlevering gestart

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden