Webhooks

Retrieve a single webhook entry by id

Changed on

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}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/webhooks/entries/{entryId}
  • Auth
    HTTP bearer

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' | 'charging-rules' 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"
  },
  "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"
}

Changes

    • breaking

      the ///// response's property type changed from array to object for status

    • warning

      added the new charging-rule enum value to the ///////// response property for the response status

    • warning

      added the new charging-rules enum value to the //// response property for the response status