POST/v1/webhooks

Izveidot webhook galapunktu

create_webhook

URL jāizmanto https, un tā resursdatora nosaukumam jāatrisinās uz publiskām adresēm. Privātie (RFC 1918), atgriezeniskās cilpas (loopback), saites lokālie (link-local), mākoņa metadatu un citi īpašam nolūkam paredzēti tīkli tiek noraidīti gan reģistrācijā, gan katrā savienojumā. Parakstīšanas noslēpums tiek parādīts vienreiz atbildē (secret); pēc tam to var tikai nomainīt pret jaunu vērtību. Organizācijai var būt ne vairāk kā 20 webhook galapunktu.

Abonements uzskaita notikumu tipus un jomu maskas (card.*, *). Piekļuve tiek iestatīta tāpat kā API atslēgai: role, data_profile_id un collection_ids. Notikums par objektu, ko loma, datu profils vai kolekcijas neredz, netiek piegādāts. tags ierobežo kartīšu notikumus ar kartītēm, kurām ir kāda no birkām. payload: thin sūta notikumus bez data. Pielāgotās galvenes (headers) un izejošā autorizācija (auth) tiek glabātas šifrētas; atbildēs ir tikai galveņu nosaukumi un karodziņi value_set un auth_set.

Autentifikācija

Nosūtiet API atslēgu galvenē Authorization: Authorization: Bearer <atslēga>.

Galvenes parametri

Idempotency-Keystring
Atslēga drošam rakstīšanas darbības atkārtojumam: 1–255 drukājamas ASCII rakstzīmes; ieteicams viens UUID v4 katrai loģiskajai operācijai. Atkārtojums ar to pašu atslēgu 24 stundu laikā operāciju neizpilda vēlreiz: tiek atgriezta saglabātā atbilde (statuss, galvenes un saturs) ar galveni Idempotency-Replayed: true. Tā pati atslēga ar citu metodi, ceļu, Content-Type vai saturu atgriež 409 api.idempotency_mismatch; kamēr pirmais pieprasījums vēl izpildās – 409 api.idempotency_in_progress ar Retry-After: 1. Pēc atbildes 5xx vai 429 atslēga tiek atbrīvota, un atkārtojums izpilda operāciju vēlreiz. Atslēga ir piesaistīta organizācijai un izsaucējam (API atslēgai, lietotājam vai pielāgotā avota atslēgai).
length ≥ 1, length ≤ 255

Pieprasījuma saturs

application/json

Objekts: WebhookCreate

urlstringobligāts
Saņēmēja URL, tikai https://, līdz 2048 rakstzīmēm.
length ≤ 2048
descriptionstring
length ≤ 200
eventsarray of WebhookEventFilterobligāts
items ≥ 1
roleWebhookRole
data_profile_idinteger | null
collection_idsarray of integer
Kolekcijas, par kurām webhook galapunkts saņem notikumus. Ja vērtības nav vai saraksts ir tukšs, tās ir visas kolekcijas, kas pieejamas lomai un datu profilam. Atslēga, kas pati ir ierobežota ar kolekcijām, izveido webhook galapunktu tikai ar netukšu savu kolekciju sarakstu. Bez šī lauka, ar tukšu sarakstu vai ar kolekciju ārpus tās saraksta pieprasījums atgriež 403 webhooks.collections_outside_key.
items ≤ 200
tagsarray of string
items ≤ 50
payloadWebhookPayloadMode
headersarray of WebhookHeaderInput
items ≤ 10
authWebhookAuthInput

Atbildes

201Izveidots. Tikai šoreiz tiek parādīts `secret`.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.
Idempotency-Replayed
true nozīmē, ka atbilde ir atkārtota no šai Idempotency-Key saglabātās atbildes: operācija netika izpildīta vēlreiz.

application/json

Objekts: WebhookCreated

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.

400Pieprasījums nav derīgs: parametra vērtība vai objekta stāvoklis neļauj veikt darbību (`detail` ir ziņojums).

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

401Nav nosūtīti akreditācijas dati (ne sesijas sīkdatne, ne API atslēga), vai atslēga nav atrasta.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

403Darbība nav atļauta: loma nav pietiekama, nav piekļuves kolekcijai vai kartītei, pieprasījums izpildās režīmā „View as“ vai organizācija ir apturēta vai dzēsta (`detail` ir objekts ar `code: org_suspended | org_deleted`).

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

409Objekta stāvoklis neļauj veikt darbību, piemēram, dublikāts, notiekoša indeksēšana vai jau apstrādāts darbs.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

422Validācijas kļūda: saturs vai parametri neatbilst shēmai (`detail` ir validācijas kļūdu saraksts), vai parametra vērtība ir ārpus pieļaujamā diapazona (`detail` ir ziņojums).

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

429Pārāk daudz pieprasījumu (`api.rate_limited`), organizācijas minūtes, dienas vai mēneša kvota ir izlietota (`api.quota_exceeded`; `error.details` satur `quota`, `limit` un `reset_at`), sasniegts organizācijas limits vai atbilžu pakalpojums ir aizņemts (`answers.engine_busy`). Pagaidiet galvenē `Retry-After` norādīto laiku.

Atbildes galvenes

Retry-After
Sekunžu skaits, kas jāpagaida, pirms atkārtojat pieprasījumu.
RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

Kļūdu kodi

Kodi, ko šī operācija var atgriezt laukā error.code papildus vispārīgajiem kodiem, kas iespējami jebkuram pieprasījumam.

Droši atkārtojumi

Ar katru POST un PATCH pieprasījumu nosūtiet galveni Idempotency-Key (piemēram, UUID). Atkārtots pieprasījums ar to pašu atslēgu 24 stundu laikā atgriež saglabāto atbildi, nevis izpilda pieprasījumu vēlreiz.

Pieprasījumu biežuma limiti

Atbildēs ir galvenes RateLimit un RateLimit-Policy, kā arī agrākās X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset. Atbildē 429 ir galvene Retry-After sekundēs: nogaidiet un atkārtojiet pieprasījumu.

← webhooks · API rokasgrāmata

curl -X POST 'https://api.sursa.com/v1/webhooks' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/webhooks/sursa","events":["card.*"]}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Izmēģināt

API atslēga

Atslēga glabājas tikai šīs cilnes atmiņā un tiek sūtīta tikai uz https://api.sursa.com.

Pieprasījumi darbojas ar jūsu organizācijas reālajiem datiem.

Idempotency-Key header

Idempotency-Key

Ja lauks ir tukšs, katram pieprasījumam tiek ģenerēta jauna atslēga.

Pieprasījuma saturs (JSON)