Developers
Diamonds

Retrieve a trigger

GET/automations/diamond/{diamond_id}/triggers/{trigger_id}

Retrieves a trigger of the Diamond. The destination is masked in the response.

The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the trigger to avoid overwriting a newer version.

Only triggers that belong to the Diamond in the path can be retrieved.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

diamond_id*string
trigger_id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/automations/diamond/string/triggers/string"
{  "data": {    "channel": "http",    "created_at": "2019-08-24T14:15:22Z",    "destination": {      "email": "string",      "phone": "string",      "url": "string"    },    "diamond_id": "string",    "enabled": true,    "event_type": "string",    "id": "string",    "object": "trigger",    "revision": "string",    "stage_id": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Ensure a stage trigger POST

Ensures that the trigger for a given stage exists. Every stage already has a trigger when the Diamond is created, so this operation normally returns the existing trigger; it creates a new one only if the stage's trigger is missing. Changes to triggers affect future communications with leads.

Update a trigger PATCH

Configures a stage trigger: whether it is enabled, its channel, destination, and template. The destination field must match the selected channel. HTTP destinations must resolve to a public host; private, loopback, and metadata addresses are rejected. The change applies to future communications with leads; nothing is sent when the trigger is updated. Send the trigger's current `ETag` in the `If-Match` header to avoid overwriting a newer version.