Objetos

WebhookCreated

Campos

• idintegerobligatorio
• urlstringobligatorio
• descriptionstringobligatorio
• eventsarray of WebhookEventFilterobligatorio
• activebooleanobligatorio
• statusWebhookStatusobligatorio
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 intentos fallidos seguidos; feature_disabled: el plan no incluye webhooks.

• disabled_reasonstring | null

  gone: el receptor respondió 410; manual: lo desactivó un administrador.

  Valores permitidos: gonemanualnull

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

  Perfil de datos del webhook (null significa sin perfil, como en una clave de API con el mismo rol).

• collection_idsarray of integerobligatorio

  Colecciones sobre las que el webhook recibe eventos; vacío significa todas las colecciones disponibles para el rol y el perfil de datos.

• tagsarray of stringobligatorio

  Eventos de tarjetas solo para las tarjetas con alguna de estas etiquetas; vacío significa sin filtro.

• payloadWebhookPayloadModeobligatorio
• headersarray of WebhookHeaderobligatorio
• auth_typestring | null

  Tipo de la autorización saliente (null significa ninguna).

  Valores permitidos: bearerbasicnull

• auth_setbooleanobligatorio

  Indica si la autorización saliente está configurada (los valores nunca se devuelven).

• previous_secret_valid_untilstring (date-time) | null

  Hasta cuándo las entregas se firman también con el secreto anterior (null significa que no hay solapamiento).

• healthWebhookHealth
• consecutive_failuresintegerobligatorio
• 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)obligatorio
• updated_atstring (date-time)obligatorio
• secretstringobligatorio

  whsec_ seguido de 32 bytes en base64 (los secretos nuevos usan el alfabeto estándar con relleno; los antiguos, base64url). Guárdelo en el lado del receptor; nunca vuelve a aparecer en las respuestas de la API. La clave de firma de Standard Webhooks es la decodificación base64 de la parte posterior a whsec_.

• previous_valid_untilstring (date-time) | null

  Hasta cuándo se sigue aceptando el secreto anterior (después de una rotación). null al crearlo.

Se usa en

• POST/v1/webhooksCrear un webhook