Webhooks

Get your webhook config

Changed on

Required scope: manage-webhooks:read

get/api/v1/webhooks/config

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/webhooks/config
  • Auth
    HTTP bearer

Response

Your Webhook config.

webhookUrlstring required

A HTTPS URL to send the webhook payload to when an event occurs.

webhookSecretstring required

A cryptoghrapic secret used to sign the webhook payload.

eventTypesWebhookEntryEventType[] required

A list of event types to subscribe to.

teamIdsinteger[] nullable

An 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).

Example response

{
  "webhookUrl": "https://partner1.com/webhooks/monta",
  "webhookSecret": "FEC64907-DE3A-4EEB-9DA8-843D45AFF00C",
  "eventTypes": [
    "charges",
    "team-members"
  ],
  "teamIds": [
    12345,
    67890
  ]
}

Changes

    • breaking

      the response property's maxLength was increased from 191 to 512 for the response status

    • warning

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