Obiekty

WebhookCreated

Pola

• idintegerwymagane
• urlstringwymagane
• descriptionstringwymagane
• eventsarray of WebhookEventFilterwymagane
• activebooleanwymagane
• statusWebhookStatuswymagane
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 nieudanych prób z rzędu; feature_disabled: plan nie obejmuje webhooków.

• disabled_reasonstring | null

  gone: odbiorca odpowiedział kodem 410; manual: wyłączony przez administratora.

  Dozwolone wartości: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRolewymagane
• data_profile_idinteger | null

  Profil dostępu webhooka (null oznacza brak profilu, jak w przypadku klucza API z tą samą rolą).

• collection_idsarray of integerwymagane

  Kolekcje, o których webhook otrzymuje zdarzenia; puste oznacza wszystkie kolekcje dostępne dla roli i profilu dostępu.

• tagsarray of stringwymagane

  Zdarzenia kart tylko dla kart z którymkolwiek z tych tagów; puste oznacza brak filtra.

• payloadWebhookPayloadModewymagane
• headersarray of WebhookHeaderwymagane
• auth_typestring | null

  Typ autoryzacji wychodzącej (null oznacza brak).

  Dozwolone wartości: bearerbasicnull

• auth_setbooleanwymagane

  Czy ustawiono autoryzację wychodzącą (wartości nigdy nie są zwracane).

• previous_secret_valid_untilstring (date-time) | null

  Do kiedy dostarczenia są podpisywane także poprzednim sekretem (null oznacza brak okresu nakładania).

• healthWebhookHealth
• consecutive_failuresintegerwymagane
• last_delivery_atstring (date-time) | null
• last_success_atstring (date-time) | null
• last_errorstring | null
• created_byinteger | null
• created_by_namestring | null
• created_atstring (date-time)wymagane
• updated_atstring (date-time)wymagane
• secretstringwymagane

  whsec_ i 32 bajty w base64 (nowe sekrety używają standardowego alfabetu z dopełnieniem, starsze – base64url). Przechowuj go po stronie odbiorcy; nigdy więcej nie pojawi się w odpowiedziach API. Kluczem podpisu Standard Webhooks jest wynik dekodowania base64 części po whsec_.

• previous_valid_untilstring (date-time) | null

  Do kiedy poprzedni sekret jest jeszcze akceptowany (po wymianie). null przy utworzeniu.

Używane przez

• POST/v1/webhooksTworzenie webhooka