Integration events

amazonApiGateway.sendRequest

A response from Amazon API Gateway endpoint has been received.
The action name of this event defaults to amazonApiGateway.sendRequest. We recommend using your own, custom name instead - you can enter it in the Response action field when configuring the "Send Request" node. This will make it easier to differentiate between events from different automations.

Default retention: 30 days

Parameter	Type	Example	Description
Base parameters	various	n/a	Parameters that may exist in all events
req.url	string	`https://example.com/hook`	URL of the request
diagramId	string	`c819738e-2d61-482c-a680-75ebdbc9a762`	Unique ID of the Automation workflow that caused this event (if applicable)
status	integer	`200`	HTTP code of the request status
blockName	string	`Assign a customer to a variant`	Name of the node, defined by the user
diagramName	string	`Abandoned cart emails`	Name of the workflow
blockId	string	`a920849d-3e72-593d-b791-86fcecd0b873`	Unique ID of the node on the canvas
name	string	`AmazonApiGateway`	Name of the integration
statusDescription	string	`OK`	Status of the request
body.＜keyPath＞	string	`exampleValue`	Data from the response body. Each property of the response body is saved as a separate parameter named after the dot notation path of the corresponding key.

Response body properties example

For the following response body:

{
    "prop1": "string",
    "prop2": [
        "value1",
        "value2"
    ],
    "prop3": {
        "key1": true,
        "key2": 15
    }
}

The following event params are generated:

Name	Value
`body.prop1`	`string`
`body.prop2[0].someKey`	`123`
`body.prop2[1].someKey`	`456`
`body.prop3.key1`	`true`
`body.prop3.key2`	`15`

eagleEye.couponCreated

A response from Eagle Eye endpoint was received.

The request was made by execution of the "Create Coupon" node.

Default retention: 30 days

Parameter	Type	Example	Description
Base parameters	various	n/a	Parameters that may exist in all events
actionId	string	`3bbcee75-cecc-5b56-8031-b6641c1ed1f1`	The identifier of the action performed by the node.
blockId	string	`a920849d-3e72-593d-b791-86fcecd0b873`	Unique ID of the node on the canvas
blockName	string	`Assign a customer to a variant`	Name of the node, defined by the user
body.＜keyPath＞	string	`exampleValue`	Data from the response body. Each property of the response body is saved as a separate parameter named after the dot notation path of the corresponding key.
diagramId	string	`c819738e-2d61-482c-a680-75ebdbc9a762`	Unique ID of the Automation workflow that caused this event (if applicable)
diagramName	string	`Abandoned cart emails`	Name of the workflow
journeyId	string	`db0a9db2-8849-5c58-9871-e07d45d64bd7`	Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, `journeyId` is the same, because it's the same workflow.
name	string	`EagleEye`	Name of the integration
pathId	number	`1`	ID of the path on which the activated node is placed
req.url	string	`https://example.com/hook`	URL of the request
statusDescription	string	`OK`	Status of the request
status	integer	`200`	HTTP code of the request status

Response body properties example

For the following response body:

{
    "prop1": "string",
    "prop2": [
        "value1",
        "value2"
    ],
    "prop3": {
        "key1": true,
        "key2": 15
    }
}

The following event params are generated:

Name	Value
`body.prop1`	`string`
`body.prop2[0].someKey`	`123`
`body.prop2[1].someKey`	`456`
`body.prop3.key1`	`true`
`body.prop3.key2`	`15`

webhook.response (and custom webhook response names)

An outgoing webhook from an Automation returned a response.

The action name of this event defaults to webhook.response. We recommend using your own, custom name instead - you can enter it in the Webhook event name field when configuring the “Outgoing Integration” node or a reusable integration. This will make it easier to differentiate between events from different automations.

Default retention: 30 days

Parameter	Type	Example	Description
Base parameters	various	n/a	Parameters that may exist in all events
diagramName	string	`Abandoned cart emails`	Name of the workflow
blockName	string	`Assign a customer to a variant`	Name of the node, defined by the user
req.url	string	`https://example.com/hook`	URL of the request
name	string	`Pull data`	Name of the webhook
statusDescription	string	`OK`	Status of the request
status	integer	`200`	HTTP code of the request status
body.＜keyPath＞	string	`exampleValue`	Data from the response body. Each property of the response body is saved as a separate parameter named after the dot notation path of the corresponding key.

Response body properties example

For the following response body:

{
    "prop1": "string",
    "prop2": [
        "value1",
        "value2"
    ],
    "prop3": {
        "key1": true,
        "key2": 15
    }
}

The following event params are generated:

Name	Value
`body.prop1`	`string`
`body.prop2[0].someKey`	`123`
`body.prop2[1].someKey`	`456`
`body.prop3.key1`	`true`
`body.prop3.key2`	`15`

Integration events

amazonApiGateway.sendRequest

Response body properties example

eagleEye.couponCreated

Response body properties example

webhook.response (and custom webhook response names)

Response body properties example

We are sorry to hear that

Awesome!