Update a webhook subscription

PATCH

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

PATCH

/webhook-gateway/webhooks/:id

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.webhooks.endpoints.update({
        id: 9,
        status: "PAUSED",
        rotate_secret: true,
    });
}
main();

{
  "webhook_id": 9,
  "name": "Connector status",
  "url": "https://hooks.example.com/ocpplab",
  "event": "energy.connector_status",
  "status": "PAUSED",
  "api_version": "1",
  "failure_count": 0,
  "created_at": "2026-10-01T09:00:00Z",
  "updated_at": "2026-10-03T10: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",
  "secret": "whsec_3q2-example-only-9Zc"
}

Pause or resume it (resuming clears failure_count), change its URL or headers, or rotate the secret (the new one is returned once).

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

The subscription’s webhook_id.

Request

This endpoint expects an object.

custom_headersmap from strings to any or nullOptional

namestring or nullOptional1-255 characters

descriptionstring or nullOptional

urlstring or nullOptionalformat: "uri">=1 character

statusenum or nullOptional

Allowed values:

rotate_secretboolean or nullOptionalDefaults to false

Response

The subscription; secret only when it was rotated.

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

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error