PATCH/v1/webhooks/{webhook_id}

Atnaujinti webhook galinį tašką

update_webhook

Pakeičia URL, aprašymą, prenumeratas, prieigą, filtrus, pasirinktines antraštes, siunčiamųjų užklausų autorizaciją ir įjungimo būseną. active: true įjungia webhook galinį tašką ir panaikina pristabdymą, todėl sukaupti pristatymai išsiunčiami iš eilės. active: false išjungia webhook galinį tašką ir atšaukia laukiančius pristatymus. headers pakeičia visą pasirinktinių antraščių sąrašą; elementas be value išlaiko ankstesnę to paties pavadinimo antraštės reikšmę. auth: null ir data_profile_id: null pašalina siunčiamųjų užklausų autorizaciją ir duomenų profilį.

Autentifikavimas

Siųskite API raktą antraštėje Authorization: Authorization: Bearer <raktas>.

Kelio parametrai

webhook_idintegerprivalomas

Antraštės parametrai

Idempotency-Keystring
Raktas saugiam rašymo operacijos pakartojimui: nuo 1 iki 255 spausdinamų ASCII simbolių; rekomenduojamas atskiras UUID v4 kiekvienai loginei operacijai. Pakartojus užklausą su tuo pačiu raktu per 24 valandas, operacija iš naujo nevykdoma: grąžinamas išsaugotas atsakas (būsena, antraštės ir turinys) su antrašte Idempotency-Replayed: true. Tas pats raktas su kitu metodu, keliu, Content-Type ar turiniu grąžina 409 api.idempotency_mismatch; kol pirmoji užklausa dar vykdoma – 409 api.idempotency_in_progress su Retry-After: 1. Po 5xx ar 429 atsako raktas atlaisvinamas, ir pakartojimas operaciją vykdo iš naujo. Raktas galioja organizacijos ir iškvietėjo (API rakto, naudotojo arba pasirinktinio šaltinio rakto) ribose.
length ≥ 1, length ≤ 255

Užklausos turinys

application/json

Objektas: WebhookUpdate

urlstring | null
length ≤ 2048
descriptionstring | null
length ≤ 200
eventsarray of WebhookEventFilter | null
items ≥ 1
activeboolean | null
rolestring | null
Leidžiamos reikšmės: admineditorviewernull
data_profile_idinteger | null
null pašalina duomenų profilį.
collection_idsarray of integer | null
Webhook galinio taško rinkiniai. Tuščias sąrašas reiškia visus vaidmeniui ir duomenų profiliui prieinamus rinkinius; reikšmės nebuvimas arba null jų nekeičia. Raktas, kuris pats apribotas rinkiniais, mato ir keičia tik tuos webhook galinius taškus, kurių rinkiniai yra jo sąraše (kiti grąžina 404 webhooks.not_found). Tuščias sąrašas arba rinkinys už jo sąrašo ribų grąžina 403 webhooks.collections_outside_key.
items ≤ 200
tagsarray of string | null
items ≤ 50
payloadstring | null
Leidžiamos reikšmės: fullthinnull
headersarray of WebhookHeaderInput | null
items ≤ 10
authWebhookAuthInput | null
null pašalina siunčiamųjų užklausų autorizaciją.

Atsakai

200Sėkmingas atsakas

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.
Idempotency-Replayed
true – atsakas pakartotas iš šiam Idempotency-Key išsaugoto atsako: operacija iš naujo nevykdyta.

application/json

Objektas: WebhookEndpoint

idintegerprivalomas
urlstringprivalomas
descriptionstringprivalomas
eventsarray of WebhookEventFilterprivalomas
activebooleanprivalomas
statusWebhookStatusprivalomas
paused_atstring (date-time) | null
paused_reasonstring | null
failures – 10 nesėkmingų bandymų iš eilės; feature_disabled – plane nėra webhook pranešimų.
disabled_reasonstring | null
gone – gavėjas atsakė 410; manual – išjungė administratorius.
Leidžiamos reikšmės: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleprivalomas
data_profile_idinteger | null
Webhook galinio taško duomenų profilis (null reiškia, kad profilio nėra, kaip API raktui su tuo pačiu vaidmeniu).
collection_idsarray of integerprivalomas
Rinkiniai, apie kuriuos webhook galinis taškas gauna įvykius; tuščias sąrašas reiškia visus vaidmeniui ir duomenų profiliui prieinamus rinkinius.
tagsarray of stringprivalomas
Kortelių įvykiai tik apie korteles, turinčias bent vieną iš šių žymų; tuščias sąrašas reiškia, kad filtro nėra.
payloadWebhookPayloadModeprivalomas
headersarray of WebhookHeaderprivalomas
auth_typestring | null
Siunčiamųjų užklausų autorizacijos tipas (null reiškia, kad jos nėra).
Leidžiamos reikšmės: bearerbasicnull
auth_setbooleanprivalomas
Ar nustatyta siunčiamųjų užklausų autorizacija (reikšmės niekada negrąžinamos).
previous_secret_valid_untilstring (date-time) | null
Iki kada pristatymai pasirašomi ir ankstesne paslaptimi (null reiškia, kad persidengimo nėra).
healthWebhookHealth
consecutive_failuresintegerprivalomas
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)privalomas
updated_atstring (date-time)privalomas

400Užklausa netinkama: parametro reikšmė arba objekto būsena neleidžia atlikti veiksmo (`detail` – pranešimas).

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

401Prisijungimo duomenys neišsiųsti (nei sesijos slapukas, nei API raktas) arba raktas nerastas.

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

403Veiksmas neleidžiamas: vaidmuo nesuteikia reikiamų teisių, nėra prieigos prie rinkinio ar kortelės, užklausa vykdoma režimu „View as“ arba organizacijos veikla sustabdyta ar organizacija ištrinta (`detail` – objektas su `code: org_suspended | org_deleted`).

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

404Objekto nėra arba jis jums nepasiekiamas. API nepatvirtina, kad ribotos prieigos objektas egzistuoja.

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

422Validavimo klaida: turinys ar parametrai neatitinka schemos (`detail` – validavimo klaidų sąrašas) arba parametro reikšmė nepatenka į leistiną intervalą (`detail` – pranešimas).

Atsako antraštės

RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

429Per daug užklausų (`api.rate_limited`), išnaudota organizacijos minutės, dienos ar mėnesio kvota (`api.quota_exceeded`; `error.details` pateikia `quota`, `limit` ir `reset_at`), pasiektas organizacijos limitas arba atsakymų paslauga užimta (`answers.engine_busy`). Palaukite tiek, kiek nurodyta antraštėje `Retry-After`.

Atsako antraštės

Retry-After
Kiek sekundžių palaukti prieš kartojant užklausą.
RateLimit-Policy
Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.
RateLimit
Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.
X-RateLimit-Remaining
Likusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-Reset
Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

Klaidų kodai

Kodai, kuriuos ši operacija gali grąžinti lauke error.code, be bendrųjų kodų, galimų bet kuriai užklausai.

Saugūs pakartojimai

Su kiekviena POST ir PATCH užklausa siųskite antraštę Idempotency-Key (pavyzdžiui, UUID). Pakartojus užklausą su tuo pačiu raktu per 24 valandas, grąžinamas išsaugotas atsakas, o užklausa iš naujo nevykdoma.

Užklausų dažnio limitai

Atsakuose yra antraštės RateLimit ir RateLimit-Policy bei ankstesnės X-RateLimit-Limit, X-RateLimit-Remaining ir X-RateLimit-Reset. Atsake 429 yra antraštė Retry-After sekundėmis: palaukite ir pakartokite užklausą.

← webhooks · API žinynas

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

Išbandyti

API raktas

Raktas laikomas tik šio skirtuko atmintyje ir siunčiamas tik į https://api.sursa.com.

Užklausos vykdomos su tikrais jūsų organizacijos duomenimis.

Idempotency-Key header

webhook_id path *

Idempotency-Key

Jei laukas tuščias, kiekvienai užklausai sugeneruojamas naujas raktas.

Užklausos turinys (JSON)