Get Gmail Inbox Trigger

Retrieve a Gmail inbox trigger, including its filters and the integration it watches.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The organization ID
project_idstringRequiredformat: "uuid"
The project ID
trigger_idstringRequiredformat: "uuid"

Response

Gmail inbox trigger details retrieved successfully
idstringformat: "uuid"
target_typeenum
Target resource type for trigger execution.
target_idstringformat: "uuid"
namestring
statusenum
Lifecycle status for triggers.
project_integration_idstringformat: "uuid"
integration_auth_principal_idstringformat: "uuid"
email_addressstring
createdstring
modifiedstring
created_by_user_idstringformat: "uuid"
task_agent_revision_idstring or nullOptionalformat: "uuid"
trigger_type"gmail_inbox"OptionalDefaults to gmail_inbox
descriptionstring or nullOptional
mailbox_watch_idstring or nullOptionalformat: "uuid"
label_idslist of strings or nullOptional
sender_filterslist of objects or nullOptional
subject_containslist of strings or nullOptional
payload_mappingmap from strings to any or nullOptional
health_stateenumOptionalDefaults to healthy
health_reasonstring or nullOptional
watch_statusenum or nullOptional

Lifecycle/health status for Gmail mailbox watches.

watch_expiration_atstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error