List webhook subscriptions

GET

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

GET

/webhook-gateway/webhooks

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.webhooks.endpoints.list({
        event_types: [
            "energy.connector_status",
        ],
        offset: 0,
        limit: 50,
    });
}
main();

{
  "items": [
    {
      "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"
      ],
      "last_success_at": "2026-10-03T10:00:00Z",
      "last_status_code": 200,
      "last_delivery_at": "2026-10-03T10:00:00Z"
    }
  ],
  "offset": 0,
  "limit": 50
}

Your organization's subscriptions. Secrets and custom header values are never returned.

Authentication

AuthorizationBearer

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

Query parameters

event_typeslist of enums or nullOptional

Only subscriptions for these event types (repeat the parameter).

offsetintegerOptional>=0Defaults to 0

Rows to skip. Pass the previous page’s next_offset to continue.

limitintegerOptional1-200Defaults to 50

Maximum rows per page (default 50, max 200).

Response

One page of subscriptions (no secrets); next_offset is null on the last page.

itemslist of objects

offsetinteger

limitinteger

next_offsetinteger or nullOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error