Webhook request headers

The headers that are included in the webhook request to provide metadata about the request and to ensure proper handling by the server.

Key	Value type	Description
`Accept`	str	Specifies acceptable media types for the response, indicating JSON with UTF-8 encoding.
`X-Event`	str	The event name.
`X-Delivery`	str	Custom header for identifying request delivery, using a unique identifier.
`Content-Type`	str	Specifies request payload media type, indicating the JSON format.
`X-Authorization-Content-SHA256`	str	Custom header containing a SHA-256 hash representing the request content, used for authorization. It is included in the request headers if a Secret is configured.

Event structure in custom action input JSON

The structure represents an event in the custom action input, containing various identifiers related to the event for processing.

Key	Value type	Description
`uuid`	int	The unique identifier for the event.
`event`	str	The event name.
`pipeline_id`	int	The ID of the pipeline associated with the event.
`trigger_result_id`	int	The ID for the result that triggered the event.
`ts_ms`	int	A timestamp indicating when the event occurred.
`custom_event`	obj	This field stores the keys and values defined during the creation of the custom event. If no keys are defined, the object is empty.

Payload structure

When the Send Webhook or Custom actions are triggered, the payload will contain the following keys that provide details about the event and the associated entities.

Key	Value type	Description
`op`	str	The operation that triggered the event.
`ts_ms`	int	A timestamp indicating when the event occurred.
`before`	obj	Custom header for identifying request delivery, using a unique identifier.
`after`	obj	Contains the resource state before the operation. In the case of a creation operation, the object is null, indicating that there was no previous state for the resource.
`organization_id`	str	The unique identifier of the organization where the event is triggered.
`team_id`	int	The ID of the team where the event is triggered.
`id`	int	The ID of the entity (e.g. item, folder, project, etc.)
`name`	str	The name of the entity (e.g. item, folder, project, etc.)
`project_id`	int	The ID of the project where the event is triggered.
`project_name`	str	The name of the project where the event is triggered. Applicable only for the "Item opened in editor" event.
`description`	str	The description of the project (null if not provided).
`folder_id`	int	The ID of the folder where the event is triggered.
`item_id`	int	The ID of the item.
`items`	arr[int]	List of item IDs.
`user_id`	str	The email address of the user who triggers the event.
`user_name`	str	The email address of the user who triggers the event. Applicable only for the "Item opened in editor" event.
`user_role`	str	The role of the user within the team who triggers the event.
`annotator_id`	str	The email address of the annotator assigned to the item (null if not assigned).
`annotator_name`	str	The name of the annotator assigned to the item (null if not assigned).
`qa_id`	str	The email address of the QA assigned to the item (null if not assigned).
`qa_name`	str	The name of the QA assigned to the item
`createdAt`	int	A timestamp indicating when the entity was created (in milliseconds since the Unix epoch).
`updatedAt`	int	A timestamp indicating when the event was triggered (in milliseconds since the Unix epoch).
`date`	str	The timestamp indicates when the event occurred. Applicable only for the "Periodic event".
`is_pinned`	bool	Indicates whether the entity is pinned (e.g. item or project).
`entropy_value`	float	A value representing the entropy of the item. Possible values: a float value or null (if not applicable)
`approval_status`	str	The approval status of the item. Possible values: "Approved", "Disapproved", or null (if no status is set).
`annotation_status`	str	The current status of annotation for the item (e.g., "Not Started", "In Progress", "Reviewed", etc.).
`status`	str	The current status of the project, folder, or exported file when the event is triggered (e.g., "NotStarted").
`action`	str	Type of action performed. Applicable only for the "Item opened in editor" event. Possible value: "ITEM_OPEN"
`attachment_name`	str	The name of the attachment linked to the project (null if not provided)
`attachment_path`	str	The path of the attachment linked to the project (null if not provided)

When the Send Webhook action is triggered by a custom event, the payload will vary based on the value types defined for the event. Refer to the possible types in the Custom event setup section.