Program Applicant webhook payload
When a Program Applicant:Added or Program Applicant:Changed webhook is
triggered, the content section of the payload includes the following
attributes:
| Attribute | Type | Description |
|---|---|---|
| id | String | The primary identifier used to identify the program applicant. |
| programType | Enum | The applicant program type. Must be one of DEVELOPER or RESELLER. |
| status | Enum | The current review status of the application. One of PENDING, APPROVED, DEFERRED, DECLINED, or DELETED. |
| appliedOn | String | The time and date when the application was submitted as an ISO-8601 formatted string. |
| lastModifiedOn | String | The time and date when the application was most recently updated as an ISO-8601 formatted string. |
| companyId | String | Optional. The identifier of the associated company, if applicable. |
| answers | Object | A map of question keys to answer objects for the application form. |
{...}:value | String or String[] | The answer value for the question. May be a single string or an array of strings. |
{...}:field | Object | Metadata describing the question field. |
{...}:field:id | String | Identifier of the field. |
{...}:field:label | String | Human-readable label for the field. |
{...}:field:type | String | Field input type (for example: input, select, multi-select). |
{...}:field:validation | String[] | Optional. Validation rules (for example: required, email, phone, url). |
{...}:field:options | Object[] | Optional. Options for select/multi_select fields. Each option has id, label, value. |
{...}:field:tag | String | Optional. Human‑readable tag/label for the field as presented in the form. |
{...}:field:props | Object | Optional. UI properties for the field (for example: displayOrder, placeholder, defaultValue, regions). Shape varies by field type. |
{...}:step | Object | Metadata describing the form step that contains the field. |
{...}:step:id | String | Identifier of the step. |
{...}:step:title | String | Title of the step. |
| tenant | String | The tenant identifier associated with the application. |
| isValidated | Boolean | Optional. Whether the application has been validated by the system. |
| magicLinkToken | String | Optional. Magic link token in the form of a UUID used for applicant verification, when applicable. |
| clientIp | String | Dependent on Feature Flag. The IP address of the applicant. |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!