Webhook Configuration

The Webhook Configuration API allows managing webhook endpoints to receive real-time notifications about bookkeeping events. Each tenant can have multiple webhook configurations, allowing events to be sent to different destinations.

Data Model

Webhook Configuration

{
  "configuration_key": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "url": "https://example.com/webhook",
  "headers": {
    "Authorization": "Bearer token",
    "X-Custom-Header": "value"
  },
  "hmac_signature_key": "secret-key"
}

Create Webhook Configuration (POST)

Request

ENDPOINT

/outgoing_webhook/webhook_configuration

METHOD

POST

Request Body

{
  "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "url": "https://example.com/webhook",
  "hmac_signature_key": "your-secret-key",
  "headers": {
    "Authorization": "Bearer token",
    "X-Custom-Header": "value"
  }
}

Request Body Params

Field	Type	Description
`tenant_key`*	string	Tenant UUID (UUID v4).
`url`*	string	Destination URL to receive webhooks.
`hmac_signature_key`*	string	Secret key for HMAC signature of webhooks.
`headers`	object	Custom headers to include in requests.

Response

STATUS

201

Response Body

{
  "configuration_key": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "url": "https://example.com/webhook",
  "headers": {
    "Authorization": "Bearer token",
    "X-Custom-Header": "value"
  },
  "hmac_signature_key": "your-secret-key"
}

Response Body Params

Field	Type	Description
`configuration_key`	string	Unique webhook configuration key (UUID v4).
`tenant_key`	string	Tenant UUID.
`url`	string	Configured destination URL.
`headers`	object	Configured custom headers.
`hmac_signature_key`	string	Secret key for HMAC signature.

List Webhook Configurations (GET)

Request

ENDPOINT

/outgoing_webhook/webhook_configuration

METHOD

GET

Query Params

Field	Type	Description
`tenant_key`*	string	Tenant UUID to filter configurations.
`page`	integer	Page number (default: 1).
`page_size`	integer	Items per page (default: 100).

Response

STATUS

200

Response Body

{
  "data": [
    {
      "configuration_key": "550e8400-e29b-41d4-a716-446655440000",
      "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "url": "https://example.com/webhook",
      "headers": {
        "Authorization": "Bearer token"
      },
      "hmac_signature_key": "your-secret-key"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 100,
    "total_rows": 15,
    "total_pages": 1
  }
}

Response Body Params

Field	Type	Description
`data`	array	List of webhook configurations.
`pagination`	object	Pagination Object.

Get Webhook Configuration by Key (GET)

Request

ENDPOINT

/outgoing_webhook/webhook_configuration/CONFIGURATION-KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
`CONFIGURATION-KEY`	string	Unique webhook configuration key (UUID v4).	36

Response

STATUS

200

Response Body

{
  "configuration_key": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "url": "https://example.com/webhook",
  "headers": {
    "Authorization": "Bearer token"
  },
  "hmac_signature_key": "your-secret-key"
}

Response Body Params

Field	Type	Description
`configuration_key`	string	Unique webhook configuration key (UUID v4).
`tenant_key`	string	Tenant UUID.
`url`	string	Configured destination URL.
`headers`	object	Configured custom headers.
`hmac_signature_key`	string	Secret key for HMAC signature.

Update Webhook Configuration (PUT)

Request

ENDPOINT

/outgoing_webhook/webhook_configuration/CONFIGURATION-KEY

METHOD

PUT

Path Params

Field	Type	Description	Characters
`CONFIGURATION-KEY`	string	Unique webhook configuration key (UUID v4).	36

Request Body

{
  "url": "https://new-url.com/webhook",
  "headers": {
    "New-Header": "new-value"
  },
  "hmac_signature_key": "new-secret-key"
}

Request Body Params

Field	Type	Description
`url`	string	New destination URL to receive webhooks.
`headers`	object	New custom headers to include in requests.
`hmac_signature_key`	string	New secret key for HMAC signature of webhooks.

Response

STATUS

200

Response Body

{
  "configuration_key": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_key": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "url": "https://new-url.com/webhook",
  "headers": {
    "New-Header": "new-value"
  },
  "hmac_signature_key": "new-secret-key"
}

Response Body Params

Field	Type	Description
`configuration_key`	string	Unique webhook configuration key (UUID v4).
`tenant_key`	string	Tenant UUID.
`url`	string	Configured destination URL.
`headers`	object	Configured custom headers.
`hmac_signature_key`	string	Secret key for HMAC signature.

Delete Webhook Configuration (DELETE)

Request

ENDPOINT

/outgoing_webhook/webhook_configuration/CONFIGURATION-KEY

METHOD

DELETE

Path Params

Field	Type	Description	Characters
`CONFIGURATION-KEY`	string	Unique webhook configuration key (UUID v4).	36

Response

STATUS

200

Response Body

{}

Webhook Configuration

Data Model​