PATCH/v1/webhooks/{webhook_id}

Uppdatera en webhook

update_webhook

Ändrar URL:en, beskrivningen, prenumerationerna, åtkomsten, filtren, egna huvuden, utgående auktorisering och om webhooken är aktiverad. active: true aktiverar webhooken och häver pausen, så att de samlade leveranserna skickas i ordning. active: false inaktiverar webhooken och avbryter väntande leveranser. headers ersätter hela listan med egna huvuden; en post utan value behåller det tidigare värdet för huvudet med samma namn. auth: null och data_profile_id: null tar bort den utgående auktoriseringen och dataprofilen.

Autentisering

Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.

Sökvägsparametrar

webhook_idintegerobligatorisk

Parametrar i huvuden

Idempotency-Keystring
Nyckel för ett säkert nytt försök med en skrivning: 1–255 utskrivbara ASCII-tecken; ett UUID v4 per logisk åtgärd rekommenderas. Ett nytt försök med samma nyckel inom 24 timmar kör inte åtgärden igen, utan returnerar det sparade svaret (status, huvuden och brödtext) med huvudet Idempotency-Replayed: true. Samma nyckel med en annan metod, sökväg, Content-Type eller brödtext returnerar 409 api.idempotency_mismatch; medan det första anropet fortfarande pågår returneras 409 api.idempotency_in_progress med Retry-After: 1. Efter ett 5xx- eller 429-svar frigörs nyckeln, och ett nytt försök kör åtgärden igen. Nyckeln gäller inom organisationen och för anroparen (API-nyckel, användare eller källnyckel för en egen källa).
length ≥ 1, length ≤ 255

Anropets brödtext

application/json

Objekt: WebhookUpdate

urlstring | null
length ≤ 2048
descriptionstring | null
length ≤ 200
eventsarray of WebhookEventFilter | null
items ≥ 1
activeboolean | null
rolestring | null
Tillåtna värden: admineditorviewernull
data_profile_idinteger | null
null tar bort dataprofilen.
collection_idsarray of integer | null
Webhookens samlingar. En tom lista betyder alla samlingar som är tillgängliga för rollen och dataprofilen; inget värde eller null lämnar dem oförändrade. En nyckel som själv är begränsad till samlingar ser och ändrar bara webhookar vars samlingar finns i dess lista (andra webhookar returnerar 404 webhooks.not_found). En tom lista eller en samling utanför dess lista returnerar 403 webhooks.collections_outside_key.
items ≤ 200
tagsarray of string | null
items ≤ 50
payloadstring | null
Tillåtna värden: fullthinnull
headersarray of WebhookHeaderInput | null
items ≤ 10
authWebhookAuthInput | null
null tar bort den utgående auktoriseringen.

Svar

200Lyckat svar

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.
Idempotency-Replayed
true betyder att svaret spelades upp från det sparade svaret för denna Idempotency-Key: åtgärden kördes inte igen.

application/json

Objekt: WebhookEndpoint

idintegerobligatorisk
urlstringobligatorisk
descriptionstringobligatorisk
eventsarray of WebhookEventFilterobligatorisk
activebooleanobligatorisk
statusWebhookStatusobligatorisk
paused_atstring (date-time) | null
paused_reasonstring | null
failures: 10 misslyckade försök i rad; feature_disabled: prisplanen omfattar inte webhookar.
disabled_reasonstring | null
gone: mottagaren svarade 410; manual: inaktiverad av en administratör.
Tillåtna värden: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleobligatorisk
data_profile_idinteger | null
Webhookens dataprofil (null betyder ingen profil, som för en API-nyckel med samma roll).
collection_idsarray of integerobligatorisk
Samlingar som webhooken tar emot händelser om; tomt betyder alla samlingar som rollen och dataprofilen har tillgång till.
tagsarray of stringobligatorisk
Korthändelser bara för kort med någon av dessa taggar; tomt betyder inget filter.
payloadWebhookPayloadModeobligatorisk
headersarray of WebhookHeaderobligatorisk
auth_typestring | null
Typ av utgående auktorisering (null betyder ingen).
Tillåtna värden: bearerbasicnull
auth_setbooleanobligatorisk
Om utgående auktorisering är angiven (värdena returneras aldrig).
previous_secret_valid_untilstring (date-time) | null
Till när leveranserna också signeras med den tidigare hemligheten (null betyder att det inte finns någon överlappning).
healthWebhookHealth
consecutive_failuresintegerobligatorisk
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)obligatorisk
updated_atstring (date-time)obligatorisk

400Anropet är ogiltigt: ett parametervärde eller objektets tillstånd tillåter inte åtgärden (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

401Inga autentiseringsuppgifter skickades (varken en sessionscookie eller en API-nyckel), eller så hittades inte nyckeln.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

403Åtgärden är inte tillåten: rollen räcker inte, det saknas åtkomst till samlingen eller kortet, anropet körs i läget ”View as” (visa som en annan användare), eller organisationen är avstängd eller borttagen (`detail` är ett objekt med `code: org_suspended | org_deleted`).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

404Objektet finns inte eller är inte tillgängligt för dig. API:et bekräftar inte att ett begränsat objekt finns.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

422Valideringsfel: brödtexten eller parametrarna stämmer inte med schemat (`detail` är en lista med valideringsfel), eller så ligger ett parametervärde utanför det tillåtna intervallet (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

429För många anrop (`api.rate_limited`), organisationens kvot för minuten, dygnet eller månaden är förbrukad (`api.quota_exceeded`; `error.details` innehåller `quota`, `limit` och `reset_at`), organisationens gräns är nådd eller svarstjänsten är upptagen (`answers.engine_busy`). Vänta den tid som anges i huvudet `Retry-After`.

Svarshuvuden

Retry-After
Antal sekunder att vänta innan du skickar anropet igen.
RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

Felkoder

Koder som den här slutpunkten kan returnera i error.code, utöver de allmänna koderna för alla anrop.

Säkra nya försök

Skicka huvudet Idempotency-Key (till exempel ett UUID) med varje POST och PATCH. Ett nytt försök med samma nyckel inom 24 timmar returnerar det sparade svaret i stället för att köra anropet igen.

Hastighetsbegränsningar

Svaren innehåller huvudena RateLimit och RateLimit-Policy samt de tidigare X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Ett 429-svar har Retry-After i sekunder: vänta och försök igen.

← webhooks · API-referens

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"

Prova

API-nyckel

Nyckeln finns bara i den här flikens minne och skickas bara till https://api.sursa.com.

Anropen påverkar din organisations riktiga data.

Idempotency-Key header

webhook_id path *

Idempotency-Key

Är fältet tomt skapas en ny nyckel för varje anrop.

Anropets brödtext (JSON)