How do I create a custom field?

Create the field under Configure > Custom Fields in the dashboard, then map it to a value in the provider's raw data. You can also do the same through the Custom Fields API.

Create and map the field

1. Go to Configure > Custom Fields and click New Field.

2. Enter a unique name in snake_case (for example rehire_date), select the category and model, and click Create.

3. Choose the mapping type: for Specific Connector or for Integration.

4. In Source, select the connector or the integration.

5. Click Data field and pick the value. On the Live data tab, search for an employee and select a value from their data. On the JSON Path tab, select a value from the sample or switch to Enter path and type the expression.

6. Click Map field, then save the mapping row with the tick.

When the value appears

The field is filled on the connector's next sync. To see it sooner, force a resync. Then request it with include_custom_fields=true.

A path that doesn't resolve doesn't cause an error: the field returns INVALID_JSON_PATH instead of a value. Preview the path before you save.

You can test expressions in the JMESPath playground.