Skip to navigation
API žinynasWebhooks

Add a webhook endpoint

View as Markdown

Events are POSTed as JSON and signed per the Standard Webhooks spec (webhook-id, webhook-timestamp, webhook-signature). The signing secret is returned once. Failed deliveries are retried for about a day.

Authentication

AuthorizationBearer

Skaitra API key (skt_…).

OR
AuthorizationBearer

OAuth 2.1 access token issued for the Skaitra resource (/mcp); see /.well-known/oauth-protected-resource.

Headers

Idempotency-KeystringOptional<=200 characters

Any unique value; a retry with the same key returns the first result.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"<=2000 characters

An https:// address.

eventTypeslist of enums or "*"Required
descriptionstringOptional<=300 characters

Response

OK
endpointobject
secretstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error
422
Unprocessable Entity Error
428
Precondition Error