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 payment-related events. Combines the allocation payment data with the common webhook envelope fields (event, timestamp, trigger, source).

Scheduled or recorded disbursement of funds against an allocation, the application-level grant slot drawn from a fund's budget.

Carries the payment amount and currency, its lifecycle status, the due and paid dates, and references to the related allocation, fund, season, payment method, and grant status.

​
allocation
object

Allocation the payment is drawn against.

​
amount
number

Amount of the payment, in the fund's currency.

​
comments
string

Comment log attached to the payment, rendered as a newline-joined export string of author (timestamp): body items. Empty string when the payment has no comments.

​
created
string<date-time>

Date and time when the payment was created.

​
currency
string

ISO 4217 currency code of the payment's amounts, drawn from the fund's currency.

​
date_due
string<date-time> | null

Date and time when the payment is due. null when no due date is set.

​
date_paid
string<date-time> | null

Date and time when the payment was made. null when the payment has not been made.

​
external_id
string

External identifier of the payment, used to reconcile it with downstream systems. Empty string when none is set.

​
grant_status
object | null

Grant status of the application the allocation belongs to.

null when the application has no grant status.

​
payment_method
object | null

Payment method recorded against the payment.

null when no payment method is set.

​
reference
string

Free-text reference for the payment. Empty string when none is set.

​
season
object

Season the payment belongs to.

​
slug
string

URL-safe identifier of the payment.

​
status
string

Lifecycle status of the payment, returned as a localised label rendered in the account's language.

Typical English labels are Scheduled, Processing, Paid, Failed, and Failed permanently.

​
updated
string<date-time>

Date and time when the payment was last updated.

​
allocation_amount
number

Total amount of the allocation the payment is drawn against, in the fund's currency.

​
applicant
object | null

Applicant who owns the application the allocation belongs to.

null when the application has no applicant.

​
application
object | null

Application the allocation belongs to.

null when the payment has no associated application.

​
fund
object

Fund the allocation draws from.

​
event
string

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

Example:

"Allocation payment 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_payment_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.