Sign in
Webhooks

Update your webhook config

Required scope: manage-webhooks:write

put/api/v1/webhooks/config

Request body

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 request

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

Response

Webhook config successfully updated.

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

No recorded changes to this endpoint across all 1 revision of this API.