New report webhook

webhook

newReport

Aera sends this request to your webhook URL when a new report is ready.
Use each fileId in the report list with Get report data.
See Get reports through the API for how to set up and verify webhooks.

Payload

event

string

enum

The event type. Needs confirmation: shown in the example but not in the field list of the source.

Allowed:

timeStamp

date-time

required

When the report was created, in UTC.

reportType

string

enum

required

The kind of report.

Allowed:

frequency

string

enum

required

How often the report is made. CUSTOM is a custom report.

Allowed:

merchantId

string

The merchant the report is for, if it is for one merchant.

chainRef

string

The chain the report is for, when present.

report

array of objects

required

The report files. A large report is split into batches, and each batch has its own file ID.

report*

Headers

Signature

string

required

Aera's signature of the request. Use it to check that Aera sent the request.

x-api-key

uuid

The API key Aera gave you when you registered your webhook URL.
Needs confirmation: header name (x-api-key or api-key) and whether it is always sent.

Response

200

Return 200 to confirm you received the webhook.
Needs confirmation: expected status code, timeout and retries.