Перейти к содержанию
Sursa для разработчиков

Объекты

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 при создании.

Используется в