Notification for partner integration activation

POST

This webhook notifies you when a company has activated you as an integration partner, meaning you are allowed to use the Partner API on said company.

Request Body^required

Media typeapplication/json

object

id

required

WebhookEventId

Event ID prefixed with “event_”. Can be used for deduplication.

string

Example

event_3f62fc97907a4212af028c30f1ea1927

event_created_at

required

WebhookEventCreatedAt

Unix timestamp when the event happened, in seconds (UTC).

integer format: int64

Example

1686089970

event_type

required

string

Allowed values: integration.created

data_version

required

integer

Allowed values: 1

data

required

object

company_key

required

The key of the company that activated the integration.

string

/^[0-9]{10}[a-f0-9]{32}$/

Example

156077433683911cdca5fd4563bded979572454cb9

vat_number

required

The VAT number of the company that activated the integration.

string

/^SE[0-9]{10}01$/

Example

SE556000475501

Responses

200

Return a 200 status to acknowledge receipt of the webhook. Any other response will cause Kivra to retry the delivery.