Bir webhook için yeni bir imzalama gizli anahtarı oluştur. Eski gizli anahtar, 24 saat boyunca
previous_secret_expires_at zamanına kadar imzalamaya devam eder. Bu süre içindeki ikinci bir yenileme, en eski gizli anahtarı hemen durdurur.
webhooks_manage kapsamını gerektirir.
İstek
Yol parametreleri
string
gerekli
Webhook kimliği (UUID).
Gövde parametreleri
Gövde isteğe bağlıdır.
boolean
varsayılan:"false"
true, örneğin bir sızıntıdan sonra mevcut gizli anahtarı hemen durdurur.
Yanıt
Başarılı olduğunda API, webhook ve yeni gizli anahtarıyla 200 OK 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. error mesajına bak.
401
Geçersiz API anahtarı.
403
API anahtarı yok veya API anahtarında webhooks_manage kapsamı bulunmuyor.
404
Webhook bulunamadı veya başka bir API anahtarına ait.