Skip to main content
POST
/
v1
/
webhook
Register a webhook endpoint
curl --request POST \
  --url https://example-supplier.co.uk/v1/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "https://my-optimiser.example.com/hooks/tariff-events"
}
'
{
  "webhook_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 Authorisation Code flow for RTI User authentication and consumer consent. Each supplier operates its own OAuth server. In production, substitute the placeholder host with the relevant url from the Supplier Register. OpenAPI does not permit URI templates in security scheme URLs, so a placeholder is used here.

Body

application/json
​
webhook_url
string<uri>
required

The HTTPS URL that will receive event notification POSTs.

Response

Webhook registered. Returns the assigned webhook ID.

​
webhook_id
string<uuid>

UUID uniquely identifying a registered webhook endpoint.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Last modified on March 28, 2026