Skip to main content
WEBHOOK

Headers

​
Signature
string
required

HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.

Generate the same value in your endpoint and compare it with this header to validate the webhook payload.

Example:

"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"

Body

application/json

Payload delivered for allocation-related events. Combines the allocation resource with the common webhook envelope fields (event, timestamp, trigger, source).

See the Webhooks guide for a full example payload.

​
slug
string

Unique identifier for the allocation.

​
amount
number

Allocated amount.

​
currency
string

Currency code.

​
paid
number

Amount paid to date.

​
applicant
object

Applicant information.

​
application
object

Associated application information.

​
fund
object

Fund information.

​
chapter
object

Chapter information.

​
season
object

Season information.

​
created
string<date-time>

Timestamp when the allocation was created.

​
updated
string<date-time>

Timestamp when the allocation was last updated.

​
event
string

Human-readable name of the event that triggered the webhook.

Example:

"Allocation created"

​
timestamp
string<date-time>

ISO 8601 formatted datetime indicating when the event occurred.

Example:

"2020-01-01T00:00:00Z"

​
trigger
string

Machine-readable event key that fired the webhook.

Example:

"allocation_created"

​
source
enum<string>
default:ui

Origin of the change that triggered the event.

Available options:
ui,
api

Response

200

Return any 2xx status code to acknowledge receipt of the event.