Pređi na sadržaj
Referenca

Webhook obaveštenja

Potpisana obaveštenja o promenama na vaše HTTPS adrese i tok istih događaja. Obaveštenje nikad nije dokaz fiskalizacije.

11 operacija

Tok događaja

get/v1/events

Scopewebhooks:read

Isti događaji koje webhook obaveštenja guraju, najstariji prvi, za poslednjih 30 dana. Sačuvajte `nextCursor` i pošaljite ga kao `after` sledeći put; kada nema novih događaja, vraća se isti kursor.

Beleške iz ugovora (OpenAPI, engleski)

Keep `nextCursor` and send it as `after` on the next call; with nothing new the same cursor comes back. Events appear a moment after they commit and stay for 30 days. Test events never appear. Scoped to the caller's environment like every other read.

Parametri

listEvents: Parametri
PoljeOpis
afteropcionoGde: queryTip: stringOpaque cursor from a previous page.

pattern ^[0-9]{1,19}$

typesopcionoGde: queryTip: stringComma-separated event types to include.
limitopcionoGde: queryTip: integer

>= 1<= 200default 100

Odgovori

listEvents: Odgovori
200OKPage of eventsWebhookEventPage
422Unprocessable ContentThe command violates a Boka or fiscal ruleErrorCode
Odgovor: WebhookEventPage

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

listEvents: Odgovor
PoljeOpis
itemsobaveznoTip: array<WebhookEvent>
idobaveznoTip: uuid
typeobaveznoTip: stringA WebhookEventType, or webhook-endpoint.test on a pushed test event.
timestampobaveznoTip: date-timeWhen the change happened, not when it was delivered.
environmentobaveznoTip: string

Vrednostisandboxproduction

dataobaveznoTip: WebhookFiscalDocumentData | WebhookReceiptDeliveryData | WebhookSecurityElementData | WebhookLicenseData | WebhookTestData

Jedna od varijanti: WebhookFiscalDocumentData | WebhookReceiptDeliveryData | WebhookSecurityElementData | WebhookLicenseData | WebhookTestData

WebhookFiscalDocumentData
fiscalDocumentIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
statusobaveznoTip: string

VrednostiFISCALIZEDOUTCOME_UNKNOWN

invoiceTypeobaveznoTip: InvoiceType

VrednostiNORMALPROFORMACOPYTRAININGADVANCE

transactionTypeobaveznoTip: TransactionType

VrednostiSALEREFUND

clientReferenceobaveznoTip: string | null (može biti null)
idempotencyKeyobaveznoTip: string
pfrInvoiceNumberobaveznoTip: string | null (može biti null)
pfrSdcTimeobaveznoTip: date-time | null (može biti null)
totalAmountobaveznoTip: number | null (može biti null)
verificationUrlobaveznoTip: uri | null (može biti null)
failureCodeobaveznoTip: string | null (može biti null)
WebhookReceiptDeliveryData
receiptDeliveryIdobaveznoTip: uuid
fiscalDocumentIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
channelobaveznoTip: const "EMAIL"
statusobaveznoTip: string

VrednostiDELIVEREDFAILED

attemptsobaveznoTip: integer

>= 1

deliveredAtobaveznoTip: date-time | null (može biti null)
failureCodeobaveznoTip: string | null (može biti null)
WebhookSecurityElementData
securityElementIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
jidobaveznoTip: string
statusobaveznoTip: string

Vrednostiactivesuspendedretired

certificateNotAfterobaveznoTip: date-time
expiryStatusopcionoTip: stringOnly on security-element.expiring.

Vrednostiwarningcritical

daysRemainingopcionoTip: integerWhole days until the certificate expires; only on security-element.expiring.

>= 0

WebhookLicenseData
statusobaveznoTip: string

Vrednostiactivesuspended

startsOnobaveznoTip: date
endsOnobaveznoTip: date | null (može biti null)
advanceModuleEnabledobaveznoTip: boolean
emailModuleEnabledobaveznoTip: boolean
WebhookTestData
webhookEndpointIdobaveznoTip: uuid
nextCursorobaveznoTip: string | null (može biti null)Send as after next time; null only before the first event.
hasMoreobaveznoTip: boolean

Pročitaj događaj

get/v1/events/{eventId}

Scopewebhooks:read

Jedan događaj iz poslednjih 30 dana, isti oblik kao telo webhook zahteva. Probni događaji se ovde ne čitaju.

Parametri

getEvent: Parametri
PoljeOpis
eventIdobaveznoGde: pathTip: uuid

Odgovori

getEvent: Odgovori
200OKEventWebhookEvent
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
Odgovor: WebhookEvent

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

getEvent: Odgovor
PoljeOpis
idobaveznoTip: uuid
typeobaveznoTip: stringA WebhookEventType, or webhook-endpoint.test on a pushed test event.
timestampobaveznoTip: date-timeWhen the change happened, not when it was delivered.
environmentobaveznoTip: string

Vrednostisandboxproduction

dataobaveznoTip: WebhookFiscalDocumentData | WebhookReceiptDeliveryData | WebhookSecurityElementData | WebhookLicenseData | WebhookTestData

Jedna od varijanti: WebhookFiscalDocumentData | WebhookReceiptDeliveryData | WebhookSecurityElementData | WebhookLicenseData | WebhookTestData

WebhookFiscalDocumentData
fiscalDocumentIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
statusobaveznoTip: string

VrednostiFISCALIZEDOUTCOME_UNKNOWN

invoiceTypeobaveznoTip: InvoiceType

VrednostiNORMALPROFORMACOPYTRAININGADVANCE

transactionTypeobaveznoTip: TransactionType

VrednostiSALEREFUND

clientReferenceobaveznoTip: string | null (može biti null)
idempotencyKeyobaveznoTip: string
pfrInvoiceNumberobaveznoTip: string | null (može biti null)
pfrSdcTimeobaveznoTip: date-time | null (može biti null)
totalAmountobaveznoTip: number | null (može biti null)
verificationUrlobaveznoTip: uri | null (može biti null)
failureCodeobaveznoTip: string | null (može biti null)
WebhookReceiptDeliveryData
receiptDeliveryIdobaveznoTip: uuid
fiscalDocumentIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
channelobaveznoTip: const "EMAIL"
statusobaveznoTip: string

VrednostiDELIVEREDFAILED

attemptsobaveznoTip: integer

>= 1

deliveredAtobaveznoTip: date-time | null (može biti null)
failureCodeobaveznoTip: string | null (može biti null)
WebhookSecurityElementData
securityElementIdobaveznoTip: uuid
taxpayerIdobaveznoTip: uuid
businessPremiseIdobaveznoTip: uuid
jidobaveznoTip: string
statusobaveznoTip: string

Vrednostiactivesuspendedretired

certificateNotAfterobaveznoTip: date-time
expiryStatusopcionoTip: stringOnly on security-element.expiring.

Vrednostiwarningcritical

daysRemainingopcionoTip: integerWhole days until the certificate expires; only on security-element.expiring.

>= 0

WebhookLicenseData
statusobaveznoTip: string

Vrednostiactivesuspended

startsOnobaveznoTip: date
endsOnobaveznoTip: date | null (može biti null)
advanceModuleEnabledobaveznoTip: boolean
emailModuleEnabledobaveznoTip: boolean
WebhookTestData
webhookEndpointIdobaveznoTip: uuid

Lista webhook adresa

get/v1/webhook-endpoints

Scopewebhooks:read

Adrese okruženja vašeg kredencijala, sa stanjem (uključena ili isključena i zašto), poslednjim uspehom i neuspehom i podatkom ko ih je dodao. Uklonjene adrese se ne prikazuju.

Beleške iz ugovora (OpenAPI, engleski)

A machine credential sees the endpoints of its own environment. A customer Owner or Administrator sees both environments unless the organization hides its sandbox data. Deleted endpoints are not listed.

Odgovori

listWebhookEndpoints: Odgovori
200OKWebhook endpointsWebhookEndpointList
Odgovor: WebhookEndpointList

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

listWebhookEndpoints: Odgovor
PoljeOpis
itemsobaveznoTip: array<WebhookEndpoint>
idobaveznoTip: uuid
environmentobaveznoTip: string

Vrednostisandboxproduction

urlobaveznoTip: uri

max 2048

descriptionobaveznoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

enabledobaveznoTip: boolean
statusobaveznoTip: string

Vrednostienableddisabled

disabledReasonobaveznoTip: string | null (može biti null)failing means 72 hours of failed deliveries without a single success; revoked means the API key or AI connection that registered the endpoint was revoked, or the AI connection lost its webhooks permission. `PUT` with `enabled: true` switches it back on.

Vrednostimanualfailingrevoked

failingSinceobaveznoTip: date-time | null (može biti null)
lastSuccessAtobaveznoTip: date-time | null (može biti null)
lastFailureAtobaveznoTip: date-time | null (može biti null)
createdByobaveznoTip: objectWho registered the endpoint. The name is returned to Owners and Administrators only, never to a machine credential.
kindobaveznoTip: string

Vrednostipersonapi-credentialai-connectionunknown

nameobaveznoTip: string | null (može biti null)

max 200

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Dodaj webhook adresu

post/v1/webhook-endpoints

Scopewebhooks:write

Registruje javnu HTTPS adresu i tipove događaja koje prima. Kredencijal uvek registruje u svom okruženju, pa `environment` može da izostavi. Isti `url` u istom okruženju postoji samo jednom (`409` vraća postojeću adresu), a organizacija ima najviše deset adresa po okruženju.

Beleške iz ugovora (OpenAPI, engleski)

The URL must be absolute https without user information or a fragment and must resolve to a public address; it is checked again at every connection. A machine credential registers in its own environment and may omit `environment`; a human must name it. One live endpoint per URL and environment: registering the same URL again answers 409 with the existing `webhookEndpointId`. At most ten endpoints per organization and environment. Free in the base licence.

Telo zahtevaapplication/json

createWebhookEndpoint: Telo zahteva
PoljeOpis
urlobaveznoTip: uri

max 2048

descriptionopcionoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

environmentopcionoTip: string | null (može biti null)Required for humans; a machine credential may omit it and always uses its own environment.

Vrednostisandboxproduction

Odgovori

createWebhookEndpoint: Odgovori
201CreatedEndpoint createdWebhookEndpoint
409ConflictThe URL is already registered in this environment, or the endpoint limit is reachedWebhookEndpointConflict
422Unprocessable ContentThe command violates a Boka or fiscal ruleErrorCode
Odgovor: WebhookEndpoint

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

createWebhookEndpoint: Odgovor
PoljeOpis
idobaveznoTip: uuid
environmentobaveznoTip: string

Vrednostisandboxproduction

urlobaveznoTip: uri

max 2048

descriptionobaveznoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

enabledobaveznoTip: boolean
statusobaveznoTip: string

Vrednostienableddisabled

disabledReasonobaveznoTip: string | null (može biti null)failing means 72 hours of failed deliveries without a single success; revoked means the API key or AI connection that registered the endpoint was revoked, or the AI connection lost its webhooks permission. `PUT` with `enabled: true` switches it back on.

Vrednostimanualfailingrevoked

failingSinceobaveznoTip: date-time | null (može biti null)
lastSuccessAtobaveznoTip: date-time | null (može biti null)
lastFailureAtobaveznoTip: date-time | null (može biti null)
createdByobaveznoTip: objectWho registered the endpoint. The name is returned to Owners and Administrators only, never to a machine credential.
kindobaveznoTip: string

Vrednostipersonapi-credentialai-connectionunknown

nameobaveznoTip: string | null (može biti null)

max 200

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Pročitaj webhook adresu

get/v1/webhook-endpoints/{webhookEndpointId}

Scopewebhooks:read

Jedna adresa po identifikatoru, isti skup polja kao lista.

Parametri

getWebhookEndpoint: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid

Odgovori

getWebhookEndpoint: Odgovori
200OKWebhook endpointWebhookEndpoint
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
Odgovor: WebhookEndpoint

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

getWebhookEndpoint: Odgovor
PoljeOpis
idobaveznoTip: uuid
environmentobaveznoTip: string

Vrednostisandboxproduction

urlobaveznoTip: uri

max 2048

descriptionobaveznoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

enabledobaveznoTip: boolean
statusobaveznoTip: string

Vrednostienableddisabled

disabledReasonobaveznoTip: string | null (može biti null)failing means 72 hours of failed deliveries without a single success; revoked means the API key or AI connection that registered the endpoint was revoked, or the AI connection lost its webhooks permission. `PUT` with `enabled: true` switches it back on.

Vrednostimanualfailingrevoked

failingSinceobaveznoTip: date-time | null (može biti null)
lastSuccessAtobaveznoTip: date-time | null (može biti null)
lastFailureAtobaveznoTip: date-time | null (može biti null)
createdByobaveznoTip: objectWho registered the endpoint. The name is returned to Owners and Administrators only, never to a machine credential.
kindobaveznoTip: string

Vrednostipersonapi-credentialai-connectionunknown

nameobaveznoTip: string | null (može biti null)

max 200

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Izmeni webhook adresu

put/v1/webhook-endpoints/{webhookEndpointId}

Scopewebhooks:write

Zamenjuje `url`, `description`, `eventTypes` i `enabled` odjednom; okruženje se ne menja. Sa `enabled: true` ponovo uključuje adresu koja je isključena ručno, posle 72 sata neuspešnih isporuka ili opozivom kredencijala koji ju je dodao. Ako je zapis u međuvremenu promenjen, `409 WEBHOOK_ENDPOINT_CHANGED` traži da ga pročitate ponovo.

Beleške iz ugovora (OpenAPI, engleski)

`enabled: true` re-enables an endpoint that was switched off by hand or after 72 hours of failed deliveries; delivery resumes with new events. The environment never changes.

Parametri

putWebhookEndpoint: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid

Telo zahtevaapplication/json

putWebhookEndpoint: Telo zahteva
PoljeOpis
urlobaveznoTip: uri

max 2048

descriptionopcionoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

enabledobaveznoTip: boolean

Odgovori

putWebhookEndpoint: Odgovori
200OKUpdated endpointWebhookEndpoint
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
409Conflict`WEBHOOK_ENDPOINT_URL_EXISTS` when another endpoint of this environment already uses the URL; `WEBHOOK_ENDPOINT_CHANGED` when the endpoint changed meanwhile (a delivery result is recorded on it after every attempt): read it again and repeat the change.Conflict
422Unprocessable ContentThe command violates a Boka or fiscal ruleErrorCode
Odgovor: WebhookEndpoint

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

putWebhookEndpoint: Odgovor
PoljeOpis
idobaveznoTip: uuid
environmentobaveznoTip: string

Vrednostisandboxproduction

urlobaveznoTip: uri

max 2048

descriptionobaveznoTip: string | null (može biti null)

max 200

eventTypesobaveznoTip: array<WebhookEventType>

Vrednostifiscal-document.fiscalizedfiscal-document.outcome-unknownreceipt-delivery.deliveredreceipt-delivery.failedsecurity-element.activatedsecurity-element.suspendedsecurity-element.retiredsecurity-element.expiringlicense.updatedmin 1 items

enabledobaveznoTip: boolean
statusobaveznoTip: string

Vrednostienableddisabled

disabledReasonobaveznoTip: string | null (može biti null)failing means 72 hours of failed deliveries without a single success; revoked means the API key or AI connection that registered the endpoint was revoked, or the AI connection lost its webhooks permission. `PUT` with `enabled: true` switches it back on.

Vrednostimanualfailingrevoked

failingSinceobaveznoTip: date-time | null (može biti null)
lastSuccessAtobaveznoTip: date-time | null (može biti null)
lastFailureAtobaveznoTip: date-time | null (može biti null)
createdByobaveznoTip: objectWho registered the endpoint. The name is returned to Owners and Administrators only, never to a machine credential.
kindobaveznoTip: string

Vrednostipersonapi-credentialai-connectionunknown

nameobaveznoTip: string | null (može biti null)

max 200

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Ukloni webhook adresu

delete/v1/webhook-endpoints/{webhookEndpointId}

Scopewebhooks:write

Uklanja adresu i otkazuje njene isporuke na čekanju. Odgovor je `204` bez tela; `409 WEBHOOK_ENDPOINT_CHANGED` znači da treba pročitati adresu i ponoviti uklanjanje.

Beleške iz ugovora (OpenAPI, engleski)

Pending deliveries are cancelled; the delivery history is kept.

Parametri

deleteWebhookEndpoint: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid

Odgovori

deleteWebhookEndpoint: Odgovori
204No ContentEndpoint removed
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
409Conflict`WEBHOOK_ENDPOINT_CHANGED`: the endpoint changed meanwhile; read it again and repeat the removal.Conflict
Odgovor: ErrorCode

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

deleteWebhookEndpoint: Odgovor
PoljeOpis
codeobaveznoTip: string
messageopcionoTip: string

Istorija isporuka

get/v1/webhook-endpoints/{webhookEndpointId}/deliveries

Scopewebhooks:read

Poslednjih 100 isporuka ka adresi, najnovije prve, sa brojem pokušaja, sledećim pokušajem i ishodom poslednjeg (`lastStatusCode`, `lastFailureCode`).

Parametri

listWebhookDeliveries: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid

Odgovori

listWebhookDeliveries: Odgovori
200OKDeliveriesWebhookDeliveryList
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
Odgovor: WebhookDeliveryList

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

listWebhookDeliveries: Odgovor
PoljeOpis
itemsobaveznoTip: array<WebhookDelivery>
idobaveznoTip: uuid
eventIdobaveznoTip: uuid
eventTypeobaveznoTip: string
statusobaveznoTip: string

Vrednostipendingsendingsucceededfailedcancelled

attemptsobaveznoTip: integer

>= 0

nextAttemptAtobaveznoTip: date-time | null (može biti null)
lastAttemptAtobaveznoTip: date-time | null (može biti null)
lastStatusCodeobaveznoTip: integer | null (može biti null)
lastFailureCodeobaveznoTip: string | null (može biti null)

VrednostiHTTP_STATUSREDIRECT_NOT_FOLLOWEDTIMEOUTCONNECTION_FAILEDDNS_FAILEDTLS_FAILEDTARGET_NOT_PUBLICINVALID_TARGET

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Pošalji isporuku ponovo

post/v1/webhook-endpoints/{webhookEndpointId}/deliveries/{webhookDeliveryId}/resend

Scopewebhooks:write

Još jedan pokušaj odmah, van rasporeda ponavljanja, za uspelu, neuspelu ili otkazanu isporuku uključene adrese. Neuspelo ponovno slanje ne pokreće novu seriju pokušaja.

Beleške iz ugovora (OpenAPI, engleski)

Allowed for succeeded, failed and cancelled deliveries of an enabled endpoint. A failed resend does not start a new retry series.

Parametri

resendWebhookDelivery: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid
webhookDeliveryIdobaveznoGde: pathTip: uuid

Odgovori

resendWebhookDelivery: Odgovori
202AcceptedDelivery queued againWebhookDelivery
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
409Conflict`WEBHOOK_DELIVERY_IN_PROGRESS` while the delivery is still queued or sending, `WEBHOOK_ENDPOINT_DISABLED` when the endpoint is switched off, `WEBHOOK_DELIVERY_CHANGED` when the delivery changed meanwhile.Conflict
Odgovor: WebhookDelivery

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

resendWebhookDelivery: Odgovor
PoljeOpis
idobaveznoTip: uuid
eventIdobaveznoTip: uuid
eventTypeobaveznoTip: string
statusobaveznoTip: string

Vrednostipendingsendingsucceededfailedcancelled

attemptsobaveznoTip: integer

>= 0

nextAttemptAtobaveznoTip: date-time | null (može biti null)
lastAttemptAtobaveznoTip: date-time | null (može biti null)
lastStatusCodeobaveznoTip: integer | null (može biti null)
lastFailureCodeobaveznoTip: string | null (može biti null)

VrednostiHTTP_STATUSREDIRECT_NOT_FOLLOWEDTIMEOUTCONNECTION_FAILEDDNS_FAILEDTLS_FAILEDTARGET_NOT_PUBLICINVALID_TARGET

createdAtobaveznoTip: date-time
updatedAtobaveznoTip: date-time

Pošalji probni događaj

post/v1/webhook-endpoints/{webhookEndpointId}/test-events

Scopewebhooks:write

Stavlja u red jedan `webhook-endpoint.test` događaj samo za ovu adresu, potpisan kao svaki drugi. Ne pojavljuje se u toku događaja i ne ide drugim adresama. Adresa mora biti uključena.

Beleške iz ugovora (OpenAPI, engleski)

The test event is never shown in the event feed and never sent to another endpoint.

Parametri

createWebhookTestEvent: Parametri
PoljeOpis
webhookEndpointIdobaveznoGde: pathTip: uuid

Odgovori

createWebhookTestEvent: Odgovori
202AcceptedTest event queuedWebhookTestEvent
404Not FoundResource does not exist within the authenticated tenant scopeErrorCode
409ConflictThe endpoint is disabledConflict
Odgovor: WebhookTestEvent

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

createWebhookTestEvent: Odgovor
PoljeOpis
eventIdobaveznoTip: uuid

Javni ključevi za potpis

get/v1/webhook-signing-keys

Scopewebhooks:read

Javni Ed25519 ključevi kojima proveravate potpis svakog webhook zahteva. Verujte svakom ključu sa liste: tokom zamene ključa lista ima dva, a svaka isporuka nosi po jedan potpis za svaki.

Beleške iz ugovora (OpenAPI, engleski)

Trust every listed key. During a rotation two keys are listed and every delivery carries one signature per key.

Odgovori

listWebhookSigningKeys: Odgovori
200OKActive public keysWebhookSigningKeyList
Odgovor: WebhookSigningKeyList

Opisi polja su preuzeti iz OpenAPI ugovora i na engleskom su; nazivi polja i vrednosti su isti u oba jezika.

listWebhookSigningKeys: Odgovor
PoljeOpis
itemsobaveznoTip: array<WebhookSigningKey>
idobaveznoTip: string
algorithmobaveznoTip: const "ed25519"
publicKeyobaveznoTip: stringStandard Webhooks public key, whpk_ followed by the base64 raw 32-byte Ed25519 key.

pattern ^whpk_[A-Za-z0-9+/]{43}=$