Pāriet uz galveno saturu
POST
Reģistrē HTTPS URL, kas saņem tīmekļa aizķeres notikumus. Tīmekļa aizķere pieder tavai API atslēgai. Tā saņem notikumu tikai par objektiem, kurus tava atslēga var lasīt. Vienai API atslēgai var piederēt ne vairāk kā 5 tīmekļa aizķeres.
Nepieciešams webhooks_manage tvērums.

Pieprasījums

Pieprasījuma satura parametri

string
obligāts
HTTPS URL 443. portā ar publisku resursdatoru un bez piekļuves datiem. Aniva neseko pāradresācijām.
string[]
obligāts
Saņemamie notikumu veidi, vismaz viens. ["*"] nozīmē visus veidus. ping nevar iekļaut sarakstā.
string[]
obligāts
1 līdz 5 adreses, uz kurām Aniva sūta e-pastus, ja piegādes atkārtoti neizdodas.
string
Brīvs teksts tavai uzziņai, ne vairāk kā 500 rakstzīmju.

Atbilde

Veiksmīgas izpildes gadījumā API atgriež 201 Created ar tīmekļa aizķeri un tās slepeno atslēgu.
string
obligāts
Parakstīšanas slepenā atslēga, whsec_ un base64. Aniva to parāda tikai šajā atbildē. Skati Paraksta pārbaude.
string
obligāts
Tīmekļa aizķeres identifikators (UUID).
string
obligāts
HTTPS URL, uz kuru Aniva sūta notikumus.
string
Brīvs teksts tavai uzziņai. Var būt null.
string[]
obligāts
Notikumu veidi, ko saņem šī tīmekļa aizķere. * nozīmē visus veidus.
string[]
obligāts
Adreses, uz kurām Aniva sūta e-pastus, ja piegādes atkārtoti neizdodas.
string
obligāts
enabled vai disabled.
string
ISO 8601 UTC laika brīdis, kad tīmekļa aizķere tika atspējota. null, kamēr tā ir iespējota.
string
Kāpēc tīmekļa aizķere tika atspējota. Skati Kļūmju paziņojumi. null, kamēr tā ir iespējota.
string
ISO 8601 UTC laika brīdis, kad sākās pašreizējā kļūmju sērija. null, ja pēdējā piegāde izdevās.
string
ISO 8601 UTC laika brīdis, kad iepriekšējā slepenā atslēga pārstāj parakstīt. null, ja nenotiek rotācija.
string
obligāts
ISO 8601 UTC laika brīdis, kad tīmekļa aizķere tika izveidota.
string
obligāts
Pēdējo izmaiņu ISO 8601 UTC laika brīdis.

Kļūdu atbildes