API-referencia: webhookok

A kimenő webhookok értesítik az Ön rendszereit, ha esemény történik a ProcessMindben. Minden kézbesítés aláírt JSON POST-kérés, amelyet az Ön webhook-titkos kulcsa hitelesít: az X-ProcessMind-Signature fejléc a sha256=<hex> értéket tartalmazza, vagyis a nyers kérés törzséből számított HMAC-SHA256 értéket. Az aláírást pontosan a kapott bájtok alapján ellenőrizze, még a JSON feldolgozása előtt, és utasítsa el azokat a kézbesítéseket, amelyek aláírása nem egyezik. Minden törzs tartalmaz egy deliveryId azonosítót is, amellyel kiszűrheti a többször kézbesített eseményeket.

Kimenő webhookok listázása

Végpont: GET /v1/tenant/{tenantId}/webhooks

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
limit	integer	lekérdezés	Nem	A visszaadandó elemek maximális száma
offset	integer	lekérdezés	Nem	Kihagyandó elemek száma

Válasz (200):

Webhookok listája

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

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Kimenő webhook létrehozása (az aláíró titkos kulcsot csak egyszer adja vissza)

Végpont: POST /v1/tenant/{tenantId}/webhooks

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid

Kérés törzse:

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

Mező	Típus	Kötelező	Leírás
url	string	Igen	Nyilvános https-végpont, amely fogadja az aláírt POST-kéréseket (privát vagy loopback cím nem használható)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Igen	Az események, amelyek elindítják a webhook kézbesítését
description	string	Nem	Opcionális leírás Maximális hossz: 500

Válasz (201):

Webhook létrehozva (az aláíró titkos kulcsot is tartalmazza)

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: uuid
url	string	Igen	Formátum: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Igen
description	string	Igen	Maximális hossz: 500
isActive	boolean	Igen	Alapértelmezett: true
createdAt	string	Igen	Formátum: date-time
secret	string	Igen	Aláíró titkos kulcs; csak itt, a létrehozáskor adja vissza a rendszer

Hibák:

• 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Egy kimenő webhook lekérése

Végpont: GET /v1/tenant/{tenantId}/webhooks/{webhookId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
webhookId	string	útvonal	Igen	Formátum: uuid

Válasz (200):

Webhook

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: uuid
url	string	Igen	Formátum: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Igen
description	string	Igen	Maximális hossz: 500
isActive	boolean	Igen	Alapértelmezett: true
createdAt	string	Igen	Formátum: date-time

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 404 Az erőforrás nem található

Kimenő webhook módosítása

Végpont: PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
webhookId	string	útvonal	Igen	Formátum: uuid

Kérés törzse:

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

Mező	Típus	Kötelező	Leírás
url	string	Nem	Nyilvános https-végpont, amely fogadja az aláírt POST-kéréseket
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Nem	Azok az események, amelyek webhook-kézbesítést indítanak
description	string	Nem	Opcionális leírás Maximális hossz: 500
isActive	boolean	Nem	Azt jelzi, hogy a webhook engedélyezve van-e

Válasz (200):

Módosított webhook

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

Mező	Típus	Kötelező	Leírás
id	string	Igen	Formátum: uuid
url	string	Igen	Formátum: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Igen
description	string	Igen	Maximális hossz: 500
isActive	boolean	Igen	Alapértelmezett: true
createdAt	string	Igen	Formátum: date-time

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 404 Az erőforrás nem található

Kimenő webhook törlése

Végpont: DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
webhookId	string	útvonal	Igen	Formátum: uuid

Válasz (200):

Webhook törölve

{
	"deleted": true
}

Mező	Típus	Kötelező	Leírás
deleted	boolean	Igen

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 404 Az erőforrás nem található

Tesztkézbesítés indítása a webhookhoz

Végpont: POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
webhookId	string	útvonal	Igen	Formátum: uuid

Válasz (200):

Tesztkézbesítés elindítva

{
	"message": "string"
}

Mező	Típus	Kötelező	Leírás
message	string	Igen

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 404 Az erőforrás nem található