Získat webhook

Hlavičky odpovědi

• RateLimit-Policy

  Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

• RateLimit

  Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

• X-RateLimit-Remaining

  Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

• X-RateLimit-Reset

  Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: WebhookEndpoint

• idintegerpovinné
• urlstringpovinné
• descriptionstringpovinné
• eventsarray of WebhookEventFilterpovinné
• activebooleanpovinné
• statusWebhookStatuspovinné
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 neúspěšných pokusů za sebou; feature_disabled: tarif nezahrnuje webhooky.

• disabled_reasonstring | null

  gone: příjemce odpověděl 410; manual: vypnuto administrátorem.

  Povolené hodnoty: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRolepovinné
• data_profile_idinteger | null

  Datový profil webhooku (null znamená bez profilu, stejně jako u klíče API se stejnou rolí).

• collection_idsarray of integerpovinné

  Kolekce, o kterých webhook dostává události; prázdné znamená všechny kolekce dostupné roli a datovému profilu.

• tagsarray of stringpovinné

  Události karet jen u karet s některým z těchto štítků; prázdné znamená bez filtru.

• payloadWebhookPayloadModepovinné
• headersarray of WebhookHeaderpovinné
• auth_typestring | null

  Typ odchozí autorizace (null znamená žádná).

  Povolené hodnoty: bearerbasicnull

• auth_setbooleanpovinné

  Zda je odchozí autorizace nastavena (hodnoty se nikdy nevracejí).

• previous_secret_valid_untilstring (date-time) | null

  Do kdy se doručení podepisují i předchozím tajným klíčem (null znamená, že překryv neexistuje).

• healthWebhookHealth
• consecutive_failuresintegerpovinné
• 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)povinné
• updated_atstring (date-time)povinné

Hlavičky odpovědi

• RateLimit-Policy

  Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

• RateLimit

  Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

• X-RateLimit-Remaining

  Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

• X-RateLimit-Reset

  Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

Hlavičky odpovědi

• RateLimit-Policy

  Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

• RateLimit

  Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

• X-RateLimit-Remaining

  Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

• X-RateLimit-Reset

  Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

Hlavičky odpovědi

• RateLimit-Policy

  Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

• RateLimit

  Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

• X-RateLimit-Remaining

  Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

• X-RateLimit-Reset

  Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

Hlavičky odpovědi

• Retry-After

  Počet sekund, které je třeba počkat před opakováním požadavku.

• RateLimit-Policy

  Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

• RateLimit

  Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

• X-RateLimit-Remaining

  Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

• X-RateLimit-Reset

  Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error