Webhooks
Get your webhook config
Required scope: manage-webhooks:read
Get your webhook config › Responses
Your Webhook config.
webhookUrlhttps://(?!(.*monta\… · requiredA HTTPS URL to send the webhook payload to when an event occurs.
webhookSecretA cryptoghrapic secret used to sign the webhook payload.
eventTypesA list of event types to subscribe to.
Custom headers to send with the webhook request. Note: Maximum of 5 headers are allowed. Must start with 'X-' (case-insensitive).
teamIdsAn optional list of team IDs. When set, only webhook events related to charge points belonging to one of the specified teams will be delivered. If omitted or set to null, events for all teams are delivered (current behaviour).
Update your webhook config
Required scope: manage-webhooks:write
Update your webhook config › Request Body
webhookUrlhttps://(?!(.*monta\… · requiredA HTTPS URL to send the webhook payload to when an event occurs.
webhookSecretA cryptoghrapic secret used to sign the webhook payload.
eventTypesA list of event types to subscribe to.
Custom headers to send with the webhook request. Note: Maximum of 5 headers are allowed. Must start with 'X-' (case-insensitive).
teamIdsAn optional list of team IDs. When set, only webhook events related to charge points belonging to one of the specified teams will be delivered. If omitted or set to null, events for all teams are delivered (current behaviour).
Update your webhook config › Responses
Webhook config successfully updated.
webhookUrlhttps://(?!(.*monta\… · requiredA HTTPS URL to send the webhook payload to when an event occurs.
webhookSecretA cryptoghrapic secret used to sign the webhook payload.
eventTypesA list of event types to subscribe to.
Custom headers to send with the webhook request. Note: Maximum of 5 headers are allowed. Must start with 'X-' (case-insensitive).
teamIdsAn optional list of team IDs. When set, only webhook events related to charge points belonging to one of the specified teams will be delivered. If omitted or set to null, events for all teams are delivered (current behaviour).
Retrieve webhook entries
This endpoint can help you debug pending/failed webhook entries. Required scope: webhooks:read
query Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
statusFilter to retrieve entries by status
Retrieve webhook entries › Responses
List of webhook entries for your consumer in the past 24 hours
Replay failed webhook entries
Queues your failed webhook entries for delivery again, with their retries reset. Narrow the replay with ids, or with fromDate (optionally toDate and eventTypes); one of ids or fromDate is required.
Note that we only persist entries for past 24 hours.
Required scope: manage-webhooks:write
Replay failed webhook entries › Request Body
idsIds of the failed entries to replay.
fromDateReplay failed entries created at or after this time.
toDateReplay failed entries created at or before this time.
eventTypesOnly replay failed entries of these event types.
Replay failed webhook entries › Responses
Number of failed entries queued for delivery again.
replayedNumber of failed entries queued for delivery again.
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
path Parameters
entryIdRetrieve a single webhook entry by id › Responses
Webhook entry with given id
eventTypeCode
payload of this entry
statusStatus of the entry
createdAtCreation date of this entry
idId of the entry
consumerIdId of the consumer this entry belongs to
operatorIdId of the operator this entry belongs to
Contains the error message if the delivery failed
updatedAtUpdate date of this entry
Endpoint to generate and explain signature details
Required scope: manage-webhooks:read.
Note that this endpoint is only for debugging purposes, is not stable and should not be used in production.
Read more here: https://docs.partner-api.monta.com/reference/generating-the-signature-example.
query Parameters
includeSecretsIf set to true, the secrets used to sign the payload will be included in the response.
webhookSecretIf provided, webhookSecret will be used instead of your actual secret.
Endpoint to generate and explain signature details › Responses
Debug output to explain signature based on your payload.
receivedPayloadStringThe processed payload as string
receivedPayloadBytesThe processed payload as bytes (hex)
webhookSecretThe secret used to sign the payload
webhookSecretBytesThe secret used to sign the payload as bytes (hex)
signatureAlgorithmThe algorithm used for generating the signature
signatureThe resulting signature
signatureWithPrefixThe resulting signature including prefix