Dokumentace API: webhooky

Odchozí webhooky upozorňují vaše systémy na události v ProcessMind. Každé doručení probíhá jako požadavek JSON POST podepsaný tajným klíčem webhooku: hlavička X-ProcessMind-Signature obsahuje sha256=<hex>, hodnotu HMAC-SHA256 vypočtenou z původního těla požadavku. Ověřte podpis přesně podle přijatých bajtů, ještě před zpracováním JSON, a odmítněte doručení, pokud podpis nesouhlasí. Každé tělo obsahuje také deliveryId, které můžete použít k odstranění duplicit při doručení s garancí alespoň jednoho doručení.

Zobrazit odchozí webhooky

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

Ověření: API key s rozsahem tenanta · rozsah read

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid
limit	integer	dotaz	Ne	Maximální počet vrácených položek
offset	integer	dotaz	Ne	Počet přeskočených položek

Odpověď (200):

Seznam webhooků

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

Chyby:

• 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key

Vytvořit odchozí webhook (podpisový tajný klíč se vrátí pouze jednou)

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

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid

Tělo požadavku:

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

Pole	Typ	Povinné	Popis
url	string	Ano	Veřejný endpoint https, který přijímá podepsaná doručení POST (nepovolují se soukromé adresy ani adresy loopback)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ano	Události, které spouštějí doručení tomuto webhooku
description	string	Ne	Volitelný popis Maximální délka: 500

Odpověď (201):

Webhook byl vytvořen (obsahuje podpisový tajný klíč)

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

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: uuid
url	string	Ano	Formát: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ano
description	string	Ano	Maximální délka: 500
isActive	boolean	Ano	Výchozí hodnota: true
createdAt	string	Ano	Formát: date-time
secret	string	Ano	Podpisový tajný klíč; vrací se pouze zde, při vytvoření

Chyby:

• 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
• 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela

Načtení jednoho odchozího webhooku

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

Ověření: API key pro konkrétního tenanta · rozsah read

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid
webhookId	string	cesta	Ano	Formát: uuid

Odpověď (200):

Webhook

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

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: uuid
url	string	Ano	Formát: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ano
description	string	Ano	Maximální délka: 500
isActive	boolean	Ano	Výchozí hodnota: true
createdAt	string	Ano	Formát: date-time

Chyby:

• 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
• 404 Zdroj nebyl nalezen

Aktualizace odchozího webhooku

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

Ověření: API key pro konkrétního tenanta · rozsah write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid
webhookId	string	cesta	Ano	Formát: uuid

Tělo požadavku:

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

Pole	Typ	Povinné	Popis
url	string	Ne	Veřejný https endpoint, který přijímá podepsané požadavky POST
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ne	Události, které spustí odeslání na tento webhook
description	string	Ne	Volitelný popis Maximální délka: 500
isActive	boolean	Ne	Určuje, zda je webhook aktivní

Odpověď (200):

Aktualizovaný webhook

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

Pole	Typ	Povinné	Popis
id	string	Ano	Formát: uuid
url	string	Ano	Formát: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ano
description	string	Ano	Maximální délka: 500
isActive	boolean	Ano	Výchozí hodnota: true
createdAt	string	Ano	Formát: date-time

Chyby:

• 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
• 404 Zdroj nebyl nalezen

Odstranění odchozího webhooku

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

Ověření: API key pro konkrétního tenanta · rozsah write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid
webhookId	string	cesta	Ano	Formát: uuid

Odpověď (200):

Webhook byl odstraněn

{
	"deleted": true
}

Pole	Typ	Povinné	Popis
deleted	boolean	Ano

Chyby:

• 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
• 404 Zdroj nebyl nalezen

Odeslání testovacího požadavku na webhook

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

Ověření: API key pro konkrétního tenanta · rozsah write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	cesta	Ano	Formát: uuid
webhookId	string	cesta	Ano	Formát: uuid

Odpověď (200):

Testovací požadavek byl odeslán

{
	"message": "string"
}

Pole	Typ	Povinné	Popis
message	string	Ano

Chyby:

• 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
• 404 Zdroj nebyl nalezen