Objekte

WebhookCreated

Felder

• idintegererforderlich
• urlstringerforderlich
• descriptionstringerforderlich
• eventsarray of WebhookEventFiltererforderlich
• activebooleanerforderlich
• statusWebhookStatuserforderlich
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 fehlgeschlagene Versuche in Folge; feature_disabled: der Tarif enthält keine Webhooks.

• disabled_reasonstring | null

  gone: der Empfänger hat mit 410 geantwortet; manual: von einem Administrator deaktiviert.

  Zulässige Werte: gonemanualnull

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

  Datenprofil des Webhooks (null bedeutet kein Profil, wie bei einem API-Schlüssel mit derselben Rolle).

• collection_idsarray of integererforderlich

  Sammlungen, über die der Webhook Ereignisse erhält; leer bedeutet alle Sammlungen, die für die Rolle und das Datenprofil verfügbar sind.

• tagsarray of stringerforderlich

  Kartenereignisse nur für Karten mit einem dieser Tags; leer bedeutet kein Filter.

• payloadWebhookPayloadModeerforderlich
• headersarray of WebhookHeadererforderlich
• auth_typestring | null

  Art der ausgehenden Autorisierung (null bedeutet keine).

  Zulässige Werte: bearerbasicnull

• auth_setbooleanerforderlich

  Ob eine ausgehende Autorisierung festgelegt ist (die Werte werden nie zurückgegeben).

• previous_secret_valid_untilstring (date-time) | null

  Bis wann Zustellungen zusätzlich mit dem vorherigen Secret signiert werden (null bedeutet, dass es keine Überlappung gibt).

• healthWebhookHealth
• consecutive_failuresintegererforderlich
• 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)erforderlich
• updated_atstring (date-time)erforderlich
• secretstringerforderlich

  whsec_ gefolgt von 32 Bytes in Base64 (neue Secrets verwenden das Standardalphabet mit Padding, ältere base64url). Speichern Sie es beim Empfänger; in API-Antworten erscheint es nie wieder. Der Signaturschlüssel nach Standard Webhooks ist die Base64-Dekodierung des Teils nach whsec_.

• previous_valid_untilstring (date-time) | null

  Bis wann das vorherige Secret noch akzeptiert wird (nach einer Rotation). null bei der Erstellung.

Verwendet von

• POST/v1/webhooksWebhook erstellen