Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Webhooks

Retrieve a single webhook entry by id

This endpoint returns a single entry by id. Note that we only persist entries for past 24 hours. Required scope: webhooks:read

get/api/v1/webhooks/entries/{entryId}

Path parameters

entryIdinteger required

Response

Webhook entry with given id

idinteger

Id of the entry

consumerIdinteger

Id of the consumer this entry belongs to

operatorIdinteger

Id of the operator this entry belongs to

eventType'charges' | 'charge-points' | 'sites' | 'users' | 'team-members' | 'teams' | 'installer-jobs' | 'wallet-transactions' | 'price-groups' | 'subscriptions' | 'plans' | 'charge-auth-tokens' | 'reports' | 'ocpp-messages' | 'charge-points-protocol-updates' required
status'pending' | 'completed' | 'failed' required
createdAtstring date-time required

Creation date of this entry

updatedAtstring date-time nullable

Update date of this entry

Example response

{
  "id": 1,
  "consumerId": 1,
  "operatorId": 1,
  "payload": {
    "entityId": "42",
    "eventTime": "2024-10-22T16:56:45.999Z",
    "payload": [
      {
        "id": "42",
        "amount": 1000
      }
    ]
  },
  "error": {
    "errorCode": "502 Bad Gateway",
    "errorMessage": "<html>\n  <head>\n    <title>Bad Gateway<\\title>\n  </head>\n  <body>\n    <p>The server is unreachable at this time.</p>\n  </body>\n</html>"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}