Skip to main content

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:

AttributeTypeDescription
idStringThe primary identifier used to identify the program applicant.
programTypeEnumThe applicant program type. Must be one of DEVELOPER or RESELLER.
statusEnumThe current review status of the application. One of PENDING, APPROVED, DEFERRED, DECLINED, or DELETED.
appliedOnStringThe time and date when the application was submitted as an ISO-8601 formatted string.
lastModifiedOnStringThe time and date when the application was most recently updated as an ISO-8601 formatted string.
companyIdStringOptional. The identifier of the associated company, if applicable.
answersObjectA map of question keys to answer objects for the application form.
{...}:valueString or String[]The answer value for the question. May be a single string or an array of strings.
{...}:fieldObjectMetadata describing the question field.
{...}:field:idStringIdentifier of the field.
{...}:field:labelStringHuman-readable label for the field.
{...}:field:typeStringField input type (for example: input, select, multi-select).
{...}:field:validationString[]Optional. Validation rules (for example: required, email, phone, url).
{...}:field:optionsObject[]Optional. Options for select/multi_select fields. Each option has id, label, value.
{...}:field:tagStringOptional. Human‑readable tag/label for the field as presented in the form.
{...}:field:propsObjectOptional. UI properties for the field (for example: displayOrder, placeholder, defaultValue, regions). Shape varies by field type.
{...}:stepObjectMetadata describing the form step that contains the field.
{...}:step:idStringIdentifier of the step.
{...}:step:titleStringTitle of the step.
tenantStringThe tenant identifier associated with the application.
isValidatedBooleanOptional. Whether the application has been validated by the system.
magicLinkTokenStringOptional. Magic link token in the form of a UUID used for applicant verification, when applicable.
clientIpStringDependent on Feature Flag. The IP address of the applicant.

Was this page helpful?