Pāriet uz saturu
Sursa Developers

Objekti

WebhookCreated

Lauki

  • idintegerobligāts
  • urlstringobligāts
  • descriptionstringobligāts
  • eventsarray of WebhookEventFilterobligāts
  • activebooleanobligāts
  • statusWebhookStatusobligāts
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 neveiksmīgi mēģinājumi pēc kārtas; feature_disabled: plāns neietver webhook paziņojumus.

  • disabled_reasonstring | null

    gone: saņēmējs atbildēja ar 410; manual: atspējojis administrators.

    Atļautās vērtības: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRoleobligāts
  • data_profile_idinteger | null

    Webhook galapunkta datu profils (null nozīmē, ka profila nav, kā API atslēgai ar to pašu lomu).

  • collection_idsarray of integerobligāts

    Kolekcijas, par kurām webhook galapunkts saņem notikumus; tukšs saraksts nozīmē visas lomai un datu profilam pieejamās kolekcijas.

  • tagsarray of stringobligāts

    Kartīšu notikumi tikai par kartītēm ar kādu no šīm birkām; tukšs saraksts nozīmē, ka filtra nav.

  • payloadWebhookPayloadModeobligāts
  • headersarray of WebhookHeaderobligāts
  • auth_typestring | null

    Izejošās autorizācijas tips (null nozīmē, ka tās nav).

    Atļautās vērtības: bearerbasicnull

  • auth_setbooleanobligāts

    Vai izejošā autorizācija ir iestatīta (vērtības nekad netiek atgrieztas).

  • previous_secret_valid_untilstring (date-time) | null

    Līdz kuram laikam piegādes tiek parakstītas arī ar iepriekšējo noslēpumu (null nozīmē, ka pārklāšanās nav).

  • healthWebhookHealth
  • consecutive_failuresintegerobligāts
  • 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)obligāts
  • updated_atstring (date-time)obligāts
  • secretstringobligāts

    whsec_ un 32 baiti base64 kodējumā (jaunie noslēpumi izmanto standarta alfabētu ar papildinājumu, vecākie – base64url). Glabājiet to saņēmēja pusē; API atbildēs tas vairs nekad neparādās. Standard Webhooks parakstīšanas atslēga ir daļas pēc whsec_ base64 dekodējums.

  • previous_valid_untilstring (date-time) | null

    Līdz kuram laikam vēl tiek pieņemts iepriekšējais noslēpums (pēc rotācijas). Izveides brīdī – null.

Izmanto