Attentive — Send Custom Event

Send a custom event to Attentive as soon as Amperity sees the customer interaction, using the custom events endpoint. Every Attentive journey that is triggered by that event type enters the subscriber, if the subscriber is opted in. The same send can first write durable custom attributes to the subscriber, so that the journey sees the new values when the subscriber enters.

This connector names an event type, not a journey or a campaign. Create the journey and its custom event trigger in Attentive first, and then enter the same event type name in Amperity.

To write subscriber attributes in real time without sending an event, use the Attentive — Update Subscriber Attributes connector instead. To send customer attributes on a schedule rather than in real time, use the Attentive API destination.

This connector sends from a real-time journey. See Real-time destinations.

Credentials

This connector uses the same credential type as the Attentive API destination and the Attentive — Update Subscriber Attributes connector. You can reuse one of those credentials here if its API key has the scopes listed below. A key set up only for the Attentive API destination usually does not have the events:write scope.

Name and description

The name and description for a credential.

API key

Required. An API key for a custom app in your Attentive account. Amperity sends the key as a bearer token with each request. See Create and manage custom apps in the Attentive documentation.

The API key must have the events:write scope. If any Activate node maps Attributes to set before the event, the key also needs the attributes:write scope. Testing the connection does not check for the attributes:write scope; a missing scope causes the send to fail.

Settings

Name and description

The name and description for a destination.

Business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow limited access to PII for this destination.

Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.

Activate node settings

The rest of the configuration for this connector belongs to the journey that sends to it. Add this destination to an Activate node, then configure the following fields on that node. Two nodes may send to the same destination with different event types, identifiers, and attributes.

Custom event type name

Required. The name of the custom event that Attentive matches journey triggers on. The name is case-sensitive and must match the journey trigger exactly.

The name may not contain any of these characters: " ' ( ) { } [ ] \ | ,

Attentive accepts the event and Amperity reports the send as successful, but no journey is triggered, in either of these cases:

  • The name does not match the journey trigger, including a difference in capitalization.

  • The subscriber is not opted in.

Email, Phone number, and Client user ID

The Amperity attributes that identify the subscriber in Attentive. Map at least one; a send with no identifier mapped fails.

  • Email is the subscriber’s email address.

  • Phone number must be in E.164 format, including the country code, such as “+15551234567”.

  • Client user ID matches only subscribers that Attentive has already associated with that ID through its Identity API.

Mapping more than one identifier tells Attentive that they belong to the same person, and Attentive associates them on one user. The identifiers are not tried one after another as fallbacks.

Event properties

Attributes sent with this event only. Use them to personalize the message or to branch the journey. Property names are case-sensitive and must match the names your Attentive templates reference. Event properties are not stored on the subscriber.

Attributes to set before the event

Durable custom attributes written to the subscriber before the event is sent, so that a journey triggered by the event sees the new values when the subscriber enters. If the attribute write fails, the event is not sent. Use Event properties instead for data that only describes this event. Leave this empty to send the event only.

Attributes written in a separate Activate node are not guaranteed to arrive before the event.

Events older than 12 hours

Attentive accepts an event that occurred more than 12 hours earlier, but does not enter the subscriber into a journey. Amperity does not send an event when more than 12 hours have passed since the send was queued. Instead, the send fails with an error that shows when the event occurred.

Failed sends

Amperity does not retry an event that Attentive rejects with a server error, because a repeated event could enter the subscriber into a journey twice. This is different from most connectors, and from attribute writes, which Amperity retries after a server error.