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

See the Webhooks guide for a full example payload.

​
applicant
object

Applicant information.

​
application
string

Application slug.

​
application_fields
array

Custom form field values for the grant report.

​
status
string

Grant report status.

​
updated
string<date-time>

Timestamp when the grant report was last updated.

​
event
string

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

Example:

"Grant report 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:

"grant_report_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.