Webhooks

order.settled

WEBHOOKorder.settled

Sent once an order reaches a terminal state. The only event we send.

Verify the signature before you give anyone value. X-GetElectric-Signature carries t=,v1=, and the signed string is the timestamp, a full stop, then the raw request body exactly as received. HMAC-SHA256 with your webhook signing secret, lowercase hex. The secret is per mode, so a test callback is signed with your test secret.

Answer 2xx. Anything else is a failure, 4xx included, and we retry after 1, 5, 15, 60, 180, 360 and 720 minutes, then stop at eight attempts.

The body names no target, provider_id or plan_id, so for airtime, data and cable TV it identifies the product only by service and your reference. Keep your own mapping from reference to what you sold.

Response
// Any 2xx tells us you have it, and we stop. Nothing in the body is read.

Authorization

This one is ours to authenticate, not yours. We sign the request and you verify the signature. Nothing of yours is sent with it.

Headers

X-GetElectric-Eventstringheaderrequired

Always order.settled.

Always order.settled

X-GetElectric-Signaturestringheaderrequired

t=<unix seconds>,v1=<lowercase hex HMAC-SHA256>.

User-Agentstringheaderrequired

Always GetElectric-Webhooks/1.

Always GetElectric-Webhooks/1

Body

eventstringrequired

Always order.settled

modestringrequired

One of live, test

referencestringrequired

Your reference. For airtime, data and cable TV this and service are the only clues to what was sold, so keep your own mapping.

statestringrequired

One of delivered, failed, refunded

settledbooleanrequired
servicestringrequired

One of electricity, airtime, data, cable_tv

amountnumberrequired
messagestringrequired
settled_atstringrequired

RFC 3339 with an offset, for example 2026-11-18T09:14:37+01:00. Different from the order endpoints, which write a bare Z.

RFC 3339 with an offset, written 2026-11-18T09:14:37+01:00.

Format date-time

meter_numberstring

Electricity only, and only when there is one.

disco_codestring

Electricity only.

transactionstring
tokenstring

Electricity, once delivered.

token_unitsnumber
refund_amountnumber

What was returned to you. Present on a refund.

Response 200

Any 2xx tells us you have it, and we stop. Nothing in the body is read.

Other responses