Към съдържанието
Sursa Developers

Обекти

WebhookCreated

Полета

  • idintegerзадължително
  • urlstringзадължително
  • descriptionstringзадължително
  • eventsarray of WebhookEventFilterзадължително
  • activebooleanзадължително
  • statusWebhookStatusзадължително
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 неуспешни опита подред; feature_disabled: планът не включва уебхукове.

  • disabled_reasonstring | null

    gone: получателят е отговорил с 410; manual: изключен от администратор.

    Допустими стойности: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRoleзадължително
  • data_profile_idinteger | null

    Профил за достъп на уебхука (null означава без профил, както при API ключ със същата роля).

  • collection_idsarray of integerзадължително

    Колекции, за които уебхукът получава събития; празно означава всички колекции, достъпни за ролята и профила за достъп.

  • tagsarray of stringзадължително

    Събития за карти само за карти с някой от тези етикети; празно означава без филтър.

  • payloadWebhookPayloadModeзадължително
  • headersarray of WebhookHeaderзадължително
  • auth_typestring | null

    Тип на изходящата оторизация (null означава без такава).

    Допустими стойности: bearerbasicnull

  • auth_setbooleanзадължително

    Дали е зададена изходяща оторизация (стойностите никога не се връщат).

  • previous_secret_valid_untilstring (date-time) | null

    До кога доставките се подписват и с предишната тайна (null означава, че няма припокриване).

  • healthWebhookHealth
  • consecutive_failuresintegerзадължително
  • 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)задължително
  • updated_atstring (date-time)задължително
  • secretstringзадължително

    whsec_, последвано от 32 байта в base64 (новите тайни използват стандартната азбука с допълване, по-старите – base64url). Съхранявайте я при получателя; тя никога повече не се появява в отговорите на API. Ключът за подписване по Standard Webhooks е декодираната от base64 част след whsec_.

  • previous_valid_untilstring (date-time) | null

    До кога предишната тайна още се приема (след смяна). null при създаване.

Използва се в