API referansı: Webhooklar

Giden webhooklar, ProcessMind içinde olaylar gerçekleştiğinde kendi sistemlerinizi bilgilendirir. Her teslimat, webhook gizli değerinizle imzalanmış bir JSON POST isteğidir: X-ProcessMind-Signature başlığı, ham istek gövdesinin HMAC-SHA256 değeri olan sha256=<hex> bilgisini içerir. İmzayı, aldığınız tam bayt dizisiyle karşılaştırarak doğrulayın, JSONu ayrıştırmadan önce bu işlemi yapın ve imzası eşleşmeyen teslimatları reddedin. Her gövde, en az bir kez teslim edilen iletileri tekilleştirmek için kullanabileceğiniz bir deliveryId de içerir.

Giden webhookları listeleyin

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	Evet	Biçim: uuid
limit	integer	sorgu	Hayır	Döndürülecek en fazla öğe sayısı
offset	integer	sorgu	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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı

Giden webhook oluşturun (imzalama gizli değeri bir kez döndürülür)

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	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 teslimatlarını alan herkese açık https uç noktası (özel/loopback adresleri kullanılamaz)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Evet	Bu webhook için teslimatı tetikleyen olaylar
description	string	Hayır	İsteğe bağlı açıklama Maksimum uzunluk: 500

Yanıt (201):

Webhook oluşturuldu (imzalama gizli değerini içerir)

{
	"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 değeri; yalnızca burada, oluşturma sırasında döndürülür

Hatalar:

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

Tek bir giden webhook alın

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	Evet	Biçim: uuid
webhookId	string	yol	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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
• 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	Gerekli	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	Gerekli	Açıklama
url	string	Hayır	İmzalı POST gönderimlerini 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 webhook için gönderimi 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	Gerekli	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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
• 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	Gerekli	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	Gerekli	Açıklama
deleted	boolean	Evet

Hatalar:

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

Webhooka test gönderimi tetikleyin

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

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

Parametreler:

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

Yanıt (200):

Test gönderimi tetiklendi

{
	"message": "string"
}

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

Hatalar:

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