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 grant status-related events. Combines the application resource with grant status information and the common webhook envelope fields (event, timestamp, trigger, source).

See the Webhooks guide for a full example payload.

​
applicant
object

Applicant information.

​
application_fields
array

Custom form field values.

​
grant_status
object

Current grant status information.

​
grant_end_date
string<date-time>

Grant end date.

​
title
string

Application title.

​
slug
string

Application slug.

​
created
string<date-time>

Timestamp when the application was created.

​
submitted
string<date-time>

Timestamp when the application was submitted.

​
updated
string<date-time>

Timestamp when the application was last updated.

​
event
string

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

Example:

"Grant status changed"

​
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:

"grant_status_changed"

​
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.