Добијање вебхука

Заглавља одговора

• RateLimit-Policy

  Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

• RateLimit

  Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

• X-RateLimit-Remaining

  Број преосталих захтева по најстрожем ограничењу.

• X-RateLimit-Reset

  Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: WebhookEndpoint

• idintegerобавезно
• urlstringобавезно
• descriptionstringобавезно
• eventsarray of WebhookEventFilterобавезно
• activebooleanобавезно
• statusWebhookStatusобавезно
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 неуспелих покушаја заредом; feature_disabled: план не обухвата вебхукове.

• disabled_reasonstring | null

  gone: прималац је одговорио са 410; manual: искључио га је администратор.

  Дозвољене вредности: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRoleобавезно
• data_profile_idinteger | null

  Профил приступа вебхука (null значи без профила, као за API кључ са истом улогом).

• collection_idsarray of integerобавезно

  Колекције о којима вебхук прима догађаје; празно значи све колекције доступне улози и профилу приступа.

• tagsarray of stringобавезно

  Догађаји картица само за картице са било којом од ових ознака; празно значи без филтера.

• payloadWebhookPayloadModeобавезно
• headersarray of WebhookHeaderобавезно
• auth_typestring | null

  Тип ауторизације одлазних захтева (null значи без ауторизације).

  Дозвољене вредности: bearerbasicnull

• auth_setbooleanобавезно

  Да ли је ауторизација одлазних захтева подешена (вредности се никада не враћају).

• previous_secret_valid_untilstring (date-time) | null

  До када се испоруке потписују и претходном тајном (null значи да нема преклапања).

• healthWebhookHealth
• consecutive_failuresintegerобавезно
• 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)обавезно
• updated_atstring (date-time)обавезно

Заглавља одговора

• RateLimit-Policy

  Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

• RateLimit

  Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

• X-RateLimit-Remaining

  Број преосталих захтева по најстрожем ограничењу.

• X-RateLimit-Reset

  Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Заглавља одговора

• RateLimit-Policy

  Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

• RateLimit

  Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

• X-RateLimit-Remaining

  Број преосталих захтева по најстрожем ограничењу.

• X-RateLimit-Reset

  Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Заглавља одговора

• RateLimit-Policy

  Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

• RateLimit

  Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

• X-RateLimit-Remaining

  Број преосталих захтева по најстрожем ограничењу.

• X-RateLimit-Reset

  Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Заглавља одговора

• Retry-After

  Број секунди које треба сачекати пре поновног покушаја захтева.

• RateLimit-Policy

  Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

• RateLimit

  Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

• X-RateLimit-Remaining

  Број преосталих захтева по најстрожем ограничењу.

• X-RateLimit-Reset

  Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error