API referansı: Webhooklar

Giden webhooklar, ProcessMind içinde olaylar gerçekleştiğinde kendi sistemlerinize bildirim gönderir. Her bildirim, webhook gizli anahtarınızla imzalanmış bir JSON POST isteğidir: X-ProcessMind-Signature başlığı sha256=<hex> değerini, yani ham istek gövdesinin HMAC-SHA256 özetini içerir. İmzayı JSON’u ayrıştırmadan önce, aldığınız bayt dizisiyle doğrulayın ve imzası eşleşmeyen bildirimleri reddedin. Her gövdede, en az bir kez teslim edilen bildirimleri tekilleştirmek için kullanabileceğiniz bir deliveryId de bulunur.

Giden webhookları listeleyin

Uç nokta: GET /v1/tenant/{tenantId}/webhooks

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid
limit	integer	query	Hayır	Döndürülecek en fazla öğe sayısı
offset	integer	query	Hayır	Atlanacak öğe sayısı

Yanıt (200):

Webhook listesi

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

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Giden webhook oluşturun (imzalama gizli anahtarı yalnızca bir kez döndürülür)

Uç nokta: POST /v1/tenant/{tenantId}/webhooks

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid

İstek gövdesi:

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

Alan	Tür	Zorunlu	Açıklama
url	string	Evet	İmzalı POST bildirimlerini alan herkese açık https uç noktası (özel veya loopback adresleri kullanılamaz)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Evet	Bu webhooka bildirim gönderilmesini tetikleyen olaylar
description	string	Hayır	İsteğe bağlı açıklama Maksimum uzunluk: 500

Yanıt (201):

Webhook oluşturuldu (imzalama gizli anahtarı yanıta dahildir)

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

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Biçim: uuid
url	string	Evet	Biçim: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Evet
description	string	Evet	Maksimum uzunluk: 500
isActive	boolean	Evet	Varsayılan: true
createdAt	string	Evet	Biçim: date-time
secret	string	Evet	İmzalama gizli anahtarı; yalnızca oluşturma sırasında burada döndürülür

Hatalar:

• 400 Hatalı istek: geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya eksik zorunlu alan gibi
• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Tek bir giden webhooku alın

Uç nokta: GET /v1/tenant/{tenantId}/webhooks/{webhookId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid
webhookId	string	path	Evet	Biçim: uuid

Yanıt (200):

Webhook

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

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Biçim: uuid
url	string	Evet	Biçim: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Evet
description	string	Evet	Maksimum uzunluk: 500
isActive	boolean	Evet	Varsayılan: true
createdAt	string	Evet	Biçim: date-time

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı

Giden webhooku güncelleyin

Uç nokta: PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid
webhookId	string	path	Evet	Biçim: uuid

İstek gövdesi:

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

Alan	Tür	Zorunlu	Açıklama
url	string	Hayır	İmzalı POST bildirimlerini alan herkese açık https uç noktası
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Hayır	Bu webhooka bildirim gönderilmesini tetikleyen olaylar
description	string	Hayır	İsteğe bağlı açıklama Maksimum uzunluk: 500
isActive	boolean	Hayır	Webhookun etkin olup olmadığı

Yanıt (200):

Webhook güncellendi

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

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Biçim: uuid
url	string	Evet	Biçim: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Evet
description	string	Evet	Maksimum uzunluk: 500
isActive	boolean	Evet	Varsayılan: true
createdAt	string	Evet	Biçim: date-time

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı

Giden webhooku silin

Uç nokta: DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid
webhookId	string	path	Evet	Biçim: uuid

Yanıt (200):

Webhook silindi

{
	"deleted": true
}

Alan	Tür	Zorunlu	Açıklama
deleted	boolean	Evet

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı

Webhooka test bildirimi gönderin

Uç nokta: POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	path	Evet	Biçim: uuid
webhookId	string	path	Evet	Biçim: uuid

Yanıt (200):

Test bildirimi gönderildi

{
	"message": "string"
}

Alan	Tür	Zorunlu	Açıklama
message	string	Evet

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı