Create a webhook subscription

POST

https://api.ocpplab.io/webhook-gateway/webhooks

POST

/webhook-gateway/webhooks

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.webhooks.endpoints.create({
        custom_headers: {
            "X-Api-Key": "your-key",
        },
        name: "Connector status",
        description: "Live status for the operations dashboard",
        url: "https://hooks.example.com/ocpplab",
        event: "energy.connector_status",
    });
}
main();

{
  "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"
}

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-255 characters

urlstringRequiredformat: "uri">=1 character

eventenumRequired

custom_headersmap from strings to any or nullOptional

descriptionstring or nullOptional

api_version"1"OptionalDefaults to 1

Response

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

webhook_idinteger

namestring

urlstring

eventenum or any

statusenum or any

api_versionstring

failure_countinteger

created_atdatetime

updated_atdatetime

descriptionstring or nullOptional

custom_header_nameslist of strings or nullOptional

last_failure_atdatetime or nullOptional

last_success_atdatetime or nullOptional

last_status_codeinteger or nullOptional

last_delivery_atdatetime or nullOptional

secretstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error