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

# Create a webhook subscription

POST https://api.ocpplab.io/webhook-gateway/webhooks
Content-Type: application/json

The URL must be HTTPS and resolve to a public address. The signing secret is returned once, in this response; store it.

Reference: https://docs.ocpplab.io/api-reference/webhooks/endpoints/create

## Authentication

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

## Request

### Body (application/json)

This endpoint expects a WebhookCreateRequest.

- `name` (string, required)
- `url` (string, required)
- `event` (enum, required)
  - Allowed values: `token.provisioned`, `token.activated`, `token.suspended`, `token.reactivated`, `token.revoked`, `token.updated`, `energy.connector_status`, `energy.asset_updated`, `energy.control_response`, `energy.power_measurement`
- `custom_headers` (map from string to any, optional, nullable)
- `description` (string, optional, nullable)
- `api_version` ("1", optional, default: 1)

## Response

### 201

The subscription with its signing secret (shown only once).

- `webhook_id` (integer, required)
- `name` (string, required)
- `url` (string, required)
- `event` (WebhookWithSecretResponseEvent, required)
- `status` (WebhookWithSecretResponseStatus, required)
- `api_version` (string, required)
- `failure_count` (integer, required)
- `created_at` (datetime, required)
- `updated_at` (datetime, required)
- `description` (string, optional, nullable)
- `custom_header_names` (list of string, optional, nullable)
- `last_failure_at` (datetime, optional, nullable)
- `last_success_at` (datetime, optional, nullable)
- `last_status_code` (integer, optional, nullable)
- `last_delivery_at` (datetime, optional, nullable)
- `secret` (string, optional, nullable)

## Errors

### 400 Bad Request Error

URL refused: it must be HTTPS and resolve only to public addresses

- `detail` (string, required) — Human-readable error message returned by the API.

### 401 Unauthorized Error

Missing or invalid Bearer token

- `detail` (string, required) — Human-readable error message returned by the API.

### 422 Unprocessable Entity Error

The request does not match the schema

- `detail` (list of ValidationError, optional) — One entry per invalid field.

### 429 Too Many Requests Error

Gateway rate limit reached; retry after the given seconds

- `detail` (string, required) — Human-readable error message returned by the API.

### 502 Bad Gateway Error

Gateway unreachable, failing, or misconfigured

- `detail` (string, required) — Human-readable error message returned by the API.

### 504 Gateway Timeout Error

Gateway timed out

- `detail` (string, required) — Human-readable error message returned by the API.

## Types

### WebhookWithSecretResponseEvent

### WebhookWithSecretResponseStatus

### ValidationError

Why one field is invalid.

- `loc` (list of ValidationErrorLocItems, required) — Where the field is: ``body`` / ``query`` / ``path`` / ``header``, then its name.
- `msg` (string, required) — What is wrong, in English.
- `type` (string, required) — Machine-readable error code, e.g. ``missing``.
- `input` (any, optional) — The value that was sent.
- `ctx` (ValidationErrorCtx, optional) — Details of the rule that failed, e.g. `{"le": 200}`.

### ValidationErrorLocItems

### ValidationErrorCtx

Details of the rule that failed, e.g. `{"le": 200}`.

## Examples

**Request**

```json
{
  "name": "Connector status",
  "url": "https://hooks.example.com/ocpplab",
  "event": "energy.connector_status",
  "custom_headers": {
    "X-Api-Key": "your-key"
  },
  "description": "Live status for the operations dashboard"
}
```

**Response**

```json
{
  "webhook_id": 9,
  "name": "Connector status",
  "url": "https://hooks.example.com/ocpplab",
  "event": "energy.connector_status",
  "status": "ACTIVE",
  "api_version": "1",
  "failure_count": 0,
  "created_at": "2026-10-01T09:00:00Z",
  "updated_at": "2026-10-01T09:00:00Z",
  "description": "Live status for the operations dashboard",
  "custom_header_names": [
    "X-Api-Key"
  ],
  "secret": "whsec_3q2-example-only-9Zc"
}
```

**SDK Code**

```python
import requests

url = "https://api.ocpplab.io/webhook-gateway/webhooks"

payload = {
    "name": "Connector status",
    "url": "https://hooks.example.com/ocpplab",
    "event": "energy.connector_status",
    "custom_headers": { "X-Api-Key": "your-key" },
    "description": "Live status for the operations dashboard"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.ocpplab.io/webhook-gateway/webhooks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Connector status","url":"https://hooks.example.com/ocpplab","event":"energy.connector_status","custom_headers":{"X-Api-Key":"your-key"},"description":"Live status for the operations dashboard"}'
};

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

```go
package main

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

func main() {

	url := "https://api.ocpplab.io/webhook-gateway/webhooks"

	payload := strings.NewReader("{\n  \"name\": \"Connector status\",\n  \"url\": \"https://hooks.example.com/ocpplab\",\n  \"event\": \"energy.connector_status\",\n  \"custom_headers\": {\n    \"X-Api-Key\": \"your-key\"\n  },\n  \"description\": \"Live status for the operations dashboard\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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
require 'uri'
require 'net/http'

url = URI("https://api.ocpplab.io/webhook-gateway/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Connector status\",\n  \"url\": \"https://hooks.example.com/ocpplab\",\n  \"event\": \"energy.connector_status\",\n  \"custom_headers\": {\n    \"X-Api-Key\": \"your-key\"\n  },\n  \"description\": \"Live status for the operations dashboard\"\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api.ocpplab.io/webhook-gateway/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Connector status\",\n  \"url\": \"https://hooks.example.com/ocpplab\",\n  \"event\": \"energy.connector_status\",\n  \"custom_headers\": {\n    \"X-Api-Key\": \"your-key\"\n  },\n  \"description\": \"Live status for the operations dashboard\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.ocpplab.io/webhook-gateway/webhooks', [
  'body' => '{
  "name": "Connector status",
  "url": "https://hooks.example.com/ocpplab",
  "event": "energy.connector_status",
  "custom_headers": {
    "X-Api-Key": "your-key"
  },
  "description": "Live status for the operations dashboard"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.ocpplab.io/webhook-gateway/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Connector status\",\n  \"url\": \"https://hooks.example.com/ocpplab\",\n  \"event\": \"energy.connector_status\",\n  \"custom_headers\": {\n    \"X-Api-Key\": \"your-key\"\n  },\n  \"description\": \"Live status for the operations dashboard\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Connector status",
  "url": "https://hooks.example.com/ocpplab",
  "event": "energy.connector_status",
  "custom_headers": ["X-Api-Key": "your-key"],
  "description": "Live status for the operations dashboard"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ocpplab.io/webhook-gateway/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()
```