For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhook API

Operations related to Web hooks

Get Webhook Configuration

get
/partner/{partnerRegNo}/webhook/configure

An API to fetch (GET) the webhook subscription for your Partner account.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/.... The latter is useful if you want to scope the subscription to a single account.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

Responses
200

OK

application/json
idstring · uuidOptionalExample: a1b2c3d4-5678-90ab-cdef-1234567890ab
urlstringOptionalExample: https://example.com/webhooks/qvalia
typesstring[]OptionalExample: ["new_document","document_delivery"]
accountRegNostringOptionalExample: SE1234567890
enabledbooleanOptionalExample: true
authTypestring · enum · nullableOptionalExample: api_keyPossible values:
createdAtstring · date-timeOptionalExample: 2024-01-01T12:00:00.000Z
updatedAtstring · date-timeOptionalExample: 2024-01-02T12:00:00.000Z
get/partner/{partnerRegNo}/webhook/configure

Configure Webhook

put
/partner/{partnerRegNo}/webhook/configure

An API to create or update (PUT) the webhook subscription for your Partner account.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/.... The latter is useful if you want to scope the subscription to a single account.

A partner has a single webhook subscription. The first PUT creates it and returns a generated webhook id (a UUID v4); subsequent PUT requests update the same subscription (its url and/or types). Use the returned id with the /partner/{partnerRegNo}/webhook/{webhookId}/auth endpoints to attach outbound authentication.

Event types

  • new_document — sent when a new document is received/created for an account.

  • document_delivery — sent when a document's delivery status changes.

Scope

This subscription receives events for every account your Partner account is allowed to receive. Use /partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure instead to scope the subscription to a single account.

Delivery (webhook usage)

Events are delivered as an HTTP POST with a JSON body to the configured url (which must be https). Your endpoint should respond with a 2xx status code; the delivery request times out after 10 seconds. If outbound authentication is configured (see /partner/{partnerRegNo}/webhook/{webhookId}/auth) it is applied as request headers on every delivery. The delivered payload is described by the webhookEvent callback below.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

Body
urlstring · uriRequired

HTTPS endpoint that will receive webhook events

Example: https://example.com/webhooks/qvalia
Responses
200

OK

application/json
idstring · uuidOptionalExample: a1b2c3d4-5678-90ab-cdef-1234567890ab
urlstringOptionalExample: https://example.com/webhooks/qvalia
typesstring[]OptionalExample: ["new_document","document_delivery"]
accountRegNostringOptionalExample: SE1234567890
put/partner/{partnerRegNo}/webhook/configure

Delete Webhook Configuration

delete
/partner/{partnerRegNo}/webhook/configure

An API to DELETE the webhook subscription for your Partner account.

This removes the subscription and any attached outbound authentication.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/.... The latter is useful if you want to scope the subscription to a single account.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

Responses
204

No Content

text/plain
stringOptionalExample: No Content
delete/partner/{partnerRegNo}/webhook/configure

Get Webhook Configuration for child account

get
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

An API to fetch (GET) the webhook subscription scoped to a single child account under your Partner account.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses
200

OK

application/json
idstring · uuidOptionalExample: a1b2c3d4-5678-90ab-cdef-1234567890ab
urlstringOptionalExample: https://example.com/webhooks/qvalia
typesstring[]OptionalExample: ["new_document","document_delivery"]
accountRegNostringOptionalExample: SE1234567890
enabledbooleanOptionalExample: true
authTypestring · enum · nullableOptionalExample: api_keyPossible values:
createdAtstring · date-timeOptionalExample: 2024-01-01T12:00:00.000Z
updatedAtstring · date-timeOptionalExample: 2024-01-02T12:00:00.000Z
get/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

Configure Webhook for child account

put
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

An API to create or update (PUT) the webhook subscription scoped to a single child account under your Partner account.

Partner or Partners Account

Partners can configure their own web hooks through /partner/{partnerRegNo}/webhook/..., or their child accounts using this endpoint (scoped to a single account).

A partner has a single webhook subscription per account. The first PUT creates it and returns a generated webhook id (a UUID v4); subsequent PUT requests update the same subscription (its url and/or types). Use the returned id with the /partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth endpoints to attach outbound authentication.

Event types

  • new_document — sent when a new document is received/created for an account.

  • document_delivery — sent when a document's delivery status changes.

Delivery (webhook usage)

Events are delivered as an HTTP POST with a JSON body to the configured url (which must be https). Your endpoint should respond with a 2xx status code; the delivery request times out after 10 seconds. If outbound authentication is configured (see /partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth) it is applied as request headers on every delivery. The delivered payload is described by the webhookEvent callback below.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Body
urlstring · uriRequired

HTTPS endpoint that will receive webhook events

Example: https://example.com/webhooks/qvalia
Responses
200

OK

application/json
idstring · uuidOptionalExample: a1b2c3d4-5678-90ab-cdef-1234567890ab
urlstringOptionalExample: https://example.com/webhooks/qvalia
typesstring[]OptionalExample: ["new_document","document_delivery"]
accountRegNostringOptionalExample: SE1234567890
put/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

Delete Webhook Configuration for child account

delete
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

An API to DELETE the webhook subscription scoped to a single child account under your Partner account.

This removes the subscription and any attached outbound authentication.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

Responses
204

No Content

text/plain
stringOptionalExample: No Content
delete/partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure

Get Webhook Authentication

get
/partner/{partnerRegNo}/webhook/{webhookId}/auth

An API to fetch (GET) the outbound authentication type configured for your Partner account's webhook subscription. Secrets are never returned.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/....

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Responses
200

OK

application/json
typestring · enumOptionalExample: api_keyPossible values:
get/partner/{partnerRegNo}/webhook/{webhookId}/auth

Set Webhook Authentication

post
/partner/{partnerRegNo}/webhook/{webhookId}/auth

An API to set (POST) the outbound authentication applied to webhook deliveries for your Partner account's subscription.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/....

{webhookId} must match the id returned by PUT /partner/{partnerRegNo}/webhook/configure.

Provide exactly one of the supported auth types:

  • oauth — client-credentials. Qvalia fetches a Bearer token from tokenUrl using clientId/clientSecret at delivery time.

  • api_key — sent as a request header (header, default X-API-Key) with value.

  • basic — HTTP Basic auth using username/password. The password must be at least 16 characters and contain an uppercase letter, a lowercase letter, a digit and a special character.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Body
or
or
Responses
200

OK

application/json
typestring · enumOptionalExample: api_keyPossible values:
post/partner/{partnerRegNo}/webhook/{webhookId}/auth

Delete Webhook Authentication

delete
/partner/{partnerRegNo}/webhook/{webhookId}/auth

An API to DELETE the outbound authentication from your Partner account's webhook subscription. The subscription itself is kept; deliveries are sent without auth headers afterwards.

Partner or Partners Account

Partners can configure their own web hooks through this endpoint, or their child accounts using /partner/{partnerRegNo}/account/{accountRegNo}/webhook/....

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Responses
204

No Content

text/plain
stringOptionalExample: No Content
delete/partner/{partnerRegNo}/webhook/{webhookId}/auth

Get Webhook Authentication for child account

get
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

An API to fetch (GET) the outbound authentication type configured for a child account's webhook subscription under your Partner account. Secrets are never returned.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Responses
200

OK

application/json
typestring · enumOptionalExample: api_keyPossible values:
get/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

Set Webhook Authentication for child account

post
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

An API to set (POST) the outbound authentication applied to webhook deliveries for a child account's subscription under your Partner account.

{webhookId} must match the id returned by PUT /partner/{partnerRegNo}/account/{accountRegNo}/webhook/configure.

Provide exactly one of the supported auth types:

  • oauth — client-credentials. Qvalia fetches a Bearer token from tokenUrl using clientId/clientSecret at delivery time.

  • api_key — sent as a request header (header, default X-API-Key) with value.

  • basic — HTTP Basic auth using username/password. The password must be at least 16 characters and contain an uppercase letter, a lowercase letter, a digit and a special character.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Body
or
or
Responses
200

OK

application/json
typestring · enumOptionalExample: api_keyPossible values:
post/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

Delete Webhook Authentication for child account

delete
/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

An API to DELETE the outbound authentication from a child account's webhook subscription under your Partner account. The subscription itself is kept; deliveries are sent without auth headers afterwards.

Authorizations
AuthorizationstringRequired
Path parameters
partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

webhookIdstring · uuidRequired

Webhook identifier returned by PUT /webhook/configure, e.g. "a1b2c3d4-5678-90ab-cdef-1234567890ab"

Responses
204

No Content

text/plain
stringOptionalExample: No Content
delete/partner/{partnerRegNo}/account/{accountRegNo}/webhook/{webhookId}/auth

Last updated

Was this helpful?