> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.solvimon.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.solvimon.com/_mcp/server.

# Create a web hook

POST https://test.api.solvimon.com/v{version}/webhooks
Content-Type: application/json

Requires the WEBHOOK.CREATE permission.

Reference: https://docs.solvimon.com/api-docs/configuration-api/webhooks/post-webhooks

## Authentication

- `X-API-KEY` header (required) — API Key authentication via header
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://test.api.solvimon.com` (The TEST environment for our API, default)
- `https://api.solvimon.com` (The live environment for our API)

## Request

### Path parameters

- `version` (string, required, default: 1) — version

### Headers

- `x-platform-id` (string, optional) — Platform ID.

### Body (application/json)

This endpoint expects a WebhookCreateRequest.

- `url` (string, required, nullable) — The url of the webhook where webhooks will be sent.
- `name` (string, required, nullable)
- `reference` (string, required, nullable)
- `object_type` (string, optional, nullable)
- `id` (string, optional, nullable)
- `username` (string, optional, nullable) — The username used for basic authentication.
- `password` (string, optional, nullable) — The password used for basic authentication.
- `api_header_field` (string, optional, nullable) — The name of the header field for authentication with an API key.
- `api_key` (string, optional, nullable) — The value of for authentication with an API key.
- `included_actions` (list of string, optional, nullable) — The actions of which a webhook will be sent.
- `excluded_actions` (list of string, optional, nullable) — The actions of which a webhook will not be sent.
- `active` (boolean, optional) — The status of the webhook.
- `penalty_box` (string, optional, nullable)
- `secret_key` (string, optional, nullable)
- `signing_protocol` (string, optional, nullable) — The signing protocol for the webhook.
- `previous_secret_key` (string, optional, nullable)
- `previous_signing_protocol` (string, optional, nullable)
- `secret_rolled_at` (string, optional, nullable) — The instant when the secret was rolled.
- `include_previous_data` (boolean, optional) — Define whether the webhook payload include the previous status or only the current status
- `authentication_type` (enum, optional) — The type of authentication used for the webhook.
  - Allowed values: `PASSWORD`, `API_KEY`, `NONE`
- `penalty_box_data` (PenaltyBoxDataCreateRequest, optional, nullable) — Indicates if this webhook is in the penalty box
- `disabled_reason` (string, optional, nullable) — The reason the webhook was automatically disabled, if applicable.

## Response

### 201

Created

- `object_type` (string, optional, nullable)
- `id` (string, optional, nullable)
- `username` (string, optional, nullable) — The username used for basic authentication.
- `password` (string, optional, nullable) — The password used for basic authentication.
- `api_header_field` (string, optional, nullable) — The name of the header field for authentication with an API key.
- `api_key` (string, optional, nullable) — The value of for authentication with an API key.
- `url` (string, optional, nullable) — The url of the webhook where webhooks will be sent.
- `included_actions` (list of string, optional, nullable) — The actions of which a webhook will be sent.
- `excluded_actions` (list of string, optional, nullable) — The actions of which a webhook will not be sent.
- `active` (boolean, optional) — The status of the webhook.
- `penalty_box` (string, optional, nullable)
- `secret_key` (string, optional, nullable)
- `signing_protocol` (string, optional, nullable) — The signing protocol for the webhook.
- `previous_secret_key` (string, optional, nullable)
- `previous_signing_protocol` (string, optional, nullable)
- `secret_rolled_at` (string, optional, nullable) — The instant when the secret was rolled.
- `include_previous_data` (boolean, optional) — Define whether the webhook payload include the previous status or only the current status
- `authentication_type` (enum, optional) — The type of authentication used for the webhook.
  - Allowed values: `PASSWORD`, `API_KEY`, `NONE`
- `penalty_box_data` (PenaltyBoxData, optional, nullable) — Indicates if this webhook is in the penalty box
- `disabled_reason` (string, optional, nullable) — The reason the webhook was automatically disabled, if applicable.
- `name` (string, optional, nullable)
- `reference` (string, optional, nullable)

## Errors

### 400 Bad Request Error

Bad Request

- `type` (enum, required)
  - Allowed values: `API_ERROR`, `INVALID_REQUEST`
- `code` (enum, required)
  - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST`
- `message` (string, required)
- `field` (string, optional, nullable)
- `resource_id` (string, optional, nullable)
- `resource_type` (enum, optional, nullable)
  - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE`

### 401 Unauthorized Error

Unauthorized

- `type` (enum, required)
  - Allowed values: `API_ERROR`, `INVALID_REQUEST`
- `code` (enum, required)
  - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST`
- `message` (string, required)
- `field` (string, optional, nullable)
- `resource_id` (string, optional, nullable)
- `resource_type` (enum, optional, nullable)
  - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE`

### 403 Forbidden Error

Forbidden

- `type` (enum, required)
  - Allowed values: `API_ERROR`, `INVALID_REQUEST`
- `code` (enum, required)
  - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST`
- `message` (string, required)
- `field` (string, optional, nullable)
- `resource_id` (string, optional, nullable)
- `resource_type` (enum, optional, nullable)
  - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE`

### 500 Internal Server Error

Internal Server Error

- `type` (enum, required)
  - Allowed values: `API_ERROR`, `INVALID_REQUEST`
- `code` (enum, required)
  - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST`
- `message` (string, required)
- `field` (string, optional, nullable)
- `resource_id` (string, optional, nullable)
- `resource_type` (enum, optional, nullable)
  - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE`

## Types

### PenaltyBoxDataCreateRequest

- `retry_count` (integer, optional, nullable) — Indicates the number of retries
- `retry_at` (string, optional, nullable) — Indicates when it will be retried
- `cause` (string, optional, nullable) — Indicates the cause why this webhook is in the penalty box
- `payload` (string, optional, nullable) — Indicates the payload sent for the webhook

### PenaltyBoxData

- `retry_count` (integer, optional, nullable) — Indicates the number of retries
- `retry_at` (string, optional, nullable) — Indicates when it will be retried
- `cause` (string, optional, nullable) — Indicates the cause why this webhook is in the penalty box
- `payload` (string, optional, nullable) — Indicates the payload sent for the webhook

## Examples

**Request**

```json
{
  "url": "https://api.lumen-ai.example.com/webhooks/solvimon",
  "name": "Invoice and payment events",
  "reference": "billing_events",
  "api_header_field": "X-Lumen-Webhook-Token",
  "api_key": "7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0",
  "included_actions": [
    "INVOICE.STATUS_TO_FINAL",
    "INVOICE.PAID"
  ],
  "active": true,
  "signing_protocol": "HmacSHA256",
  "include_previous_data": true
}
```

**Response**

```json
{
  "object_type": "string",
  "id": "string",
  "username": "string",
  "api_header_field": "string",
  "url": "string",
  "included_actions": [
    "string"
  ],
  "excluded_actions": [
    "string"
  ],
  "active": true,
  "penalty_box": "string",
  "secret_key": "string",
  "signing_protocol": "string",
  "previous_secret_key": "string",
  "previous_signing_protocol": "string",
  "secret_rolled_at": "string",
  "include_previous_data": true,
  "authentication_type": "PASSWORD",
  "penalty_box_data": {
    "retry_count": 1,
    "retry_at": "string",
    "cause": "string",
    "payload": "string"
  },
  "disabled_reason": "string",
  "name": "string",
  "reference": "string"
}
```

**SDK Code**

```python Webhooks_postWebhooks_example
import requests

url = "https://test.api.solvimon.com/v1/webhooks"

payload = {
    "url": "https://api.lumen-ai.example.com/webhooks/solvimon",
    "name": "Invoice and payment events",
    "reference": "billing_events",
    "api_header_field": "X-Lumen-Webhook-Token",
    "api_key": "7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0",
    "included_actions": ["INVOICE.STATUS_TO_FINAL", "INVOICE.PAID"],
    "active": True,
    "signing_protocol": "HmacSHA256",
    "include_previous_data": True
}
headers = {
    "X-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Webhooks_postWebhooks_example
const url = 'https://test.api.solvimon.com/v1/webhooks';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"url":"https://api.lumen-ai.example.com/webhooks/solvimon","name":"Invoice and payment events","reference":"billing_events","api_header_field":"X-Lumen-Webhook-Token","api_key":"7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0","included_actions":["INVOICE.STATUS_TO_FINAL","INVOICE.PAID"],"active":true,"signing_protocol":"HmacSHA256","include_previous_data":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Webhooks_postWebhooks_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.api.solvimon.com/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://api.lumen-ai.example.com/webhooks/solvimon\",\n  \"name\": \"Invoice and payment events\",\n  \"reference\": \"billing_events\",\n  \"api_header_field\": \"X-Lumen-Webhook-Token\",\n  \"api_key\": \"7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0\",\n  \"included_actions\": [\n    \"INVOICE.STATUS_TO_FINAL\",\n    \"INVOICE.PAID\"\n  ],\n  \"active\": true,\n  \"signing_protocol\": \"HmacSHA256\",\n  \"include_previous_data\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Webhooks_postWebhooks_example
require 'uri'
require 'net/http'

url = URI("https://test.api.solvimon.com/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://api.lumen-ai.example.com/webhooks/solvimon\",\n  \"name\": \"Invoice and payment events\",\n  \"reference\": \"billing_events\",\n  \"api_header_field\": \"X-Lumen-Webhook-Token\",\n  \"api_key\": \"7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0\",\n  \"included_actions\": [\n    \"INVOICE.STATUS_TO_FINAL\",\n    \"INVOICE.PAID\"\n  ],\n  \"active\": true,\n  \"signing_protocol\": \"HmacSHA256\",\n  \"include_previous_data\": true\n}"

response = http.request(request)
puts response.read_body
```

```java Webhooks_postWebhooks_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://test.api.solvimon.com/v1/webhooks")
  .header("X-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.lumen-ai.example.com/webhooks/solvimon\",\n  \"name\": \"Invoice and payment events\",\n  \"reference\": \"billing_events\",\n  \"api_header_field\": \"X-Lumen-Webhook-Token\",\n  \"api_key\": \"7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0\",\n  \"included_actions\": [\n    \"INVOICE.STATUS_TO_FINAL\",\n    \"INVOICE.PAID\"\n  ],\n  \"active\": true,\n  \"signing_protocol\": \"HmacSHA256\",\n  \"include_previous_data\": true\n}")
  .asString();
```

```php Webhooks_postWebhooks_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://test.api.solvimon.com/v1/webhooks', [
  'body' => '{
  "url": "https://api.lumen-ai.example.com/webhooks/solvimon",
  "name": "Invoice and payment events",
  "reference": "billing_events",
  "api_header_field": "X-Lumen-Webhook-Token",
  "api_key": "7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0",
  "included_actions": [
    "INVOICE.STATUS_TO_FINAL",
    "INVOICE.PAID"
  ],
  "active": true,
  "signing_protocol": "HmacSHA256",
  "include_previous_data": true
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Webhooks_postWebhooks_example
using RestSharp;

var client = new RestClient("https://test.api.solvimon.com/v1/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://api.lumen-ai.example.com/webhooks/solvimon\",\n  \"name\": \"Invoice and payment events\",\n  \"reference\": \"billing_events\",\n  \"api_header_field\": \"X-Lumen-Webhook-Token\",\n  \"api_key\": \"7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0\",\n  \"included_actions\": [\n    \"INVOICE.STATUS_TO_FINAL\",\n    \"INVOICE.PAID\"\n  ],\n  \"active\": true,\n  \"signing_protocol\": \"HmacSHA256\",\n  \"include_previous_data\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Webhooks_postWebhooks_example
import Foundation

let headers = [
  "X-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "https://api.lumen-ai.example.com/webhooks/solvimon",
  "name": "Invoice and payment events",
  "reference": "billing_events",
  "api_header_field": "X-Lumen-Webhook-Token",
  "api_key": "7Qm2Xc9LpV4tRz8Nf3Bd6YhK1sWa5Ge0",
  "included_actions": ["INVOICE.STATUS_TO_FINAL", "INVOICE.PAID"],
  "active": true,
  "signing_protocol": "HmacSHA256",
  "include_previous_data": true
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.solvimon.com/v1/webhooks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```