• Webhooks API

Webhook Endpoints

get

List webhook endpoints

Returns a paginated list of webhook endpoints for the authenticated network.

limitint

Maximum number of items to return

Default
20
Min
1
Max
100
startingAfterstring

Cursor for pagination. Pass the ID of the last item from the previous page.

Responses

Response examples

Success

{
  "data": {
    "items": [
      {
        "id": "wh_abc123",
        "networkId": "n_abc123",
        "url": "https://example.com/webhook",
        "enabledEvents": [
          "ocpp.message"
        ],
        "status": "active",
        "createdAt": "2023-06-07T17:32:28Z"
      }
    ],
    "hasMore": true
  }
}
post

Create a webhook endpoint

Creates a new webhook endpoint for receiving event notifications. The webhook secret is only returned once at creation time - store it securely.

urlstring

required

The URL where webhook events will be delivered

Format
uri
Example
"https://example.com/webhook"
enabledEventsarray

required

List of event types to subscribe to

The type of event that triggers the webhook

Enum
  • ocpp.message
  • asset.connectivity
statusstring

The status of the webhook endpoint

Enum
  • active
  • inactive

Responses

Request examples

{
  "url": "https://example.com/webhook",
  "enabledEvents": [
    "ocpp.message"
  ],
  "status": "active"
}

Response examples

Webhook endpoint created successfully

{
  "data": {
    "id": "wh_abc123",
    "networkId": "n_abc123",
    "url": "https://example.com/webhook",
    "enabledEvents": [
      "ocpp.message"
    ],
    "status": "active",
    "secret": "whsec_abc123def456...",
    "createdAt": "2023-06-07T17:32:28Z"
  }
}
get

Get a webhook endpoint

Retrieves a specific webhook endpoint by ID. The webhook secret is not included in the response.

idstring

required

The webhook endpoint ID

Responses

Response examples

Success

{
  "data": {
    "id": "wh_abc123",
    "networkId": "n_abc123",
    "url": "https://example.com/webhook",
    "enabledEvents": [
      "ocpp.message"
    ],
    "status": "active",
    "createdAt": "2023-06-07T17:32:28Z"
  }
}
delete

Delete a webhook endpoint

Permanently deletes a webhook endpoint. This action cannot be undone.

idstring

required

The webhook endpoint ID

Responses

Response examples

Webhook endpoint deleted successfully

Empty response

patch

Update a webhook endpoint

Updates the enabledEvents and/or status of a webhook endpoint.

enabledEventsarray

List of event types to subscribe to

The type of event that triggers the webhook

Enum
  • ocpp.message
  • asset.connectivity
statusstring

The status of the webhook endpoint

Enum
  • active
  • inactive

Responses

Request examples

{
  "enabledEvents": [
    "ocpp.message"
  ],
  "status": "active"
}

Response examples

Webhook endpoint updated successfully

{
  "data": {
    "id": "wh_abc123",
    "networkId": "n_abc123",
    "url": "https://example.com/webhook",
    "enabledEvents": [
      "ocpp.message"
    ],
    "status": "active",
    "createdAt": "2023-06-07T17:32:28Z"
  }
}

Was this page helpful?