Objektit

WebhookCreated

Kentät

• idintegerpakollinen
• urlstringpakollinen
• descriptionstringpakollinen
• eventsarray of WebhookEventFilterpakollinen
• activebooleanpakollinen
• statusWebhookStatuspakollinen
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 epäonnistunutta yritystä peräkkäin; feature_disabled: paketti ei sisällä webhookeja.

• disabled_reasonstring | null

  gone: vastaanottaja vastasi koodilla 410; manual: ylläpitäjä poisti webhookin käytöstä.

  Sallitut arvot: gonemanualnull

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

  Webhookin dataprofiili (null tarkoittaa, ettei profiilia ole, kuten API-avaimella, jolla on sama rooli).

• collection_idsarray of integerpakollinen

  Kokoelmat, joiden tapahtumia webhook vastaanottaa; tyhjä tarkoittaa kaikkia roolin ja dataprofiilin sallimia kokoelmia.

• tagsarray of stringpakollinen

  Korttitapahtumat vain korteista, joilla on jokin näistä tunnisteista; tyhjä tarkoittaa, ettei suodatinta ole.

• payloadWebhookPayloadModepakollinen
• headersarray of WebhookHeaderpakollinen
• auth_typestring | null

  Lähtevän valtuutuksen tyyppi (null tarkoittaa, ettei sitä ole).

  Sallitut arvot: bearerbasicnull

• auth_setbooleanpakollinen

  Onko lähtevä valtuutus asetettu (arvoja ei koskaan palauteta).

• previous_secret_valid_untilstring (date-time) | null

  Mihin asti toimitukset allekirjoitetaan myös edellisellä salaisuudella (null tarkoittaa, ettei päällekkäisyysjaksoa ole).

• healthWebhookHealth
• consecutive_failuresintegerpakollinen
• 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)pakollinen
• updated_atstring (date-time)pakollinen
• secretstringpakollinen

  whsec_ ja sen perässä 32 tavua base64-muodossa (uudet salaisuudet käyttävät vakioaakkostoa täytteen kanssa, vanhemmat base64url-muotoa). Tallenna se vastaanottajan puolelle; se ei enää koskaan näy API:n vastauksissa. Standard Webhooks -allekirjoitusavain on whsec_-alun jälkeisen osan base64-dekoodaus.

• previous_valid_untilstring (date-time) | null

  Mihin asti edellinen salaisuus vielä hyväksytään (uusimisen jälkeen). Luonnissa null.

Käytössä

• POST/v1/webhooksLuo webhook