User custom field updated

webhook

user.customfield.updated

Sent to your endpoint when a user custom field is renamed in your platform. Changing only the case or the spaces in a name does not trigger this event.

Payload

The payload sent to your endpoint when the event is triggered.

type

string

enum

required

The type of the event.

Allowed:

timestamp

integer

required

The date and time when the event was triggered in your platform, in the Unix epoch format (number of milliseconds that have elapsed since January 1, 1970).

data

object

required

The data associated with the event.

Headers

webhook-signature

string

required

The signature of the event payload, used to verify the authenticity of the event. If multiple signatures are present, they are space delimited.

webhook-id

string

required

The unique identifier of the event. It is the same ID for the retry attempts of the same event.

webhook-timestamp

string

required

The date and time when the event was emitted, in the Unix epoch format (number of seconds that have elapsed since January 1, 1970).

Responses

2XX

The event is considered as accepted for any 2xx response code.

default

The event is considered as rejected for any other response code. The event emission will be retried later.