{ "error": "An API key can own at most 5 webhooks"}
Webhook olaylarını alan bir HTTPS URL’si kaydet. Webhook, API anahtarına
aittir. Yalnızca anahtarının okuyabildiği nesneler için olay alır. Bir API anahtarı en fazla 5
webhook sahibi olabilir.
webhooks_manage kapsamını gerektirir.
İstek
Gövde parametreleri
string
gerekli
443 portunda, herkese açık bir ana bilgisayar kullanan ve kimlik bilgisi içermeyen HTTPS URL’si. Aniva yönlendirmeleri takip etmez.
string[]
gerekli
Alınacak olay türleri, en az bir tane. ["*"] tüm türler anlamına gelir.
ping listelenemez.
string[]
gerekli
Teslimatlar sürekli başarısız olduğunda Aniva’nın e-posta göndereceği 1 ila 5 adres.
string
Kendi referansın için serbest metin, en fazla 500 karakter.
Yanıt
Başarılı olduğunda API, webhook ve gizli anahtarıyla birlikte 201 Created döndürür.
string
gerekli
İmzalama gizli anahtarı, whsec_ ve ardından base64. Aniva bunu yalnızca bu yanıtta gösterir. Bkz. İmzayı
doğrula.
string
gerekli
Webhook kimliği (UUID).
string
gerekli
Aniva’nın olayları gönderdiği HTTPS URL’si.
string
Kendi referansın için serbest metin. null olabilir.
string[]
gerekli
Bu webhook’un aldığı olay türleri. * tüm türler anlamına gelir.
string[]
gerekli
Teslimatlar sürekli başarısız olduğunda Aniva’nın e-posta gönderdiği adresler.
string
gerekli
enabled veya disabled.
string
Webhook’un devre dışı bırakıldığı ISO 8601 UTC zamanı. Etkin durumdayken null.
string
Webhook’un neden devre dışı bırakıldığı. Bkz. Hata bildirimleri. Etkin durumdayken
null.
string
Mevcut başarısızlık serisinin başladığı ISO 8601 UTC zamanı. Son teslimat başarılı olduğunda null.
string
Önceki gizli anahtarın imzalamayı durduracağı ISO 8601 UTC zamanı. Anahtar döndürme devam etmiyorken null.
string
gerekli
Webhook’un oluşturulduğu ISO 8601 UTC zamanı.
string
gerekli
Son değişikliğin ISO 8601 UTC zamanı.
Hata yanıtları
Durum
Açıklama
400
Geçersiz istek; örneğin hatalı bir URL, bilinmeyen bir olay türü, geçersiz alert_emails veya webhook sahibi olamayan bir API anahtarı.
401
Geçersiz API anahtarı.
403
API anahtarı yok veya API anahtarında webhooks_manage kapsamı bulunmuyor.