Skip to content

Commit a70db6b

Browse files
xc0n42markzegarelli
xc0n42
and
markzegarelli
authored
CUSTINT-19134: Emarsys (Actions) documentation (#4354)
* CUSTINT-19134: Emarsys (Actions) documentation * Add ID and private metadata * set private --------- Co-authored-by: markzegarelli <[email protected]>
1 parent 3eb4829 commit a70db6b

File tree

3 files changed

+348
-6
lines changed

3 files changed

+348
-6
lines changed

‎.github/styles/Vocab/Docs/accept.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ deeplink
5252
Dev
5353
Doubleclick
5454
Eloqua
55+
Emarsys
5556
enablement
5657
endcapture
5758
endfor
@@ -120,6 +121,7 @@ Pipedrive
120121
Preact
121122
Qualtrics
122123
reformat(:?s)
124+
remarket
123125
Responsys
124126
Rokt
125127
Sabil
@@ -151,5 +153,4 @@ Wisepops
151153
Woopra
152154
Wootric
153155
Xcode
154-
Zendesk
155-
remarket
156+
Zendesk

‎src/_data/catalog/destinations_private.yml

Lines changed: 307 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2023-03-02
2+
# destination data last updated 2023-03-06
33
items:
44
- id: 62b256147cbb49302d1486d0
55
display_name: Heap Web (Actions)
@@ -1243,12 +1243,12 @@ items:
12431243
slug: actions-livelike-cloud
12441244
previous_names:
12451245
- LiveLike
1246-
website: http://www.segment.com
1246+
website: https://livelike.com/
12471247
status: PRIVATE_BETA
12481248
logo:
1249-
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
1249+
url: https://cdn.filepicker.io/api/file/y0c13dP7ScqXe1On30WC
12501250
mark:
1251-
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
1251+
url: https://cdn.filepicker.io/api/file/7Wr7YJJQUyaBpftnbszQ
12521252
methods:
12531253
track: true
12541254
identify: false
@@ -1482,3 +1482,306 @@ items:
14821482
properties:
14831483
'@path': $.properties
14841484
trigger: type = "page"
1485+
- id: 63f65c1c42e3bded41f0499c
1486+
display_name: Emarsys (Actions)
1487+
name: Emarsys (Actions)
1488+
slug: actions-emarsys
1489+
previous_names:
1490+
- Emarsys (Actions)
1491+
website: http://www.emarsys.com
1492+
status: PRIVATE_BETA
1493+
logo:
1494+
url: https://cdn.filepicker.io/api/file/a2LVYLBfR2mLIs3MzvPo
1495+
mark:
1496+
url: https://cdn.filepicker.io/api/file/engQ0gGiQ5ywznrR5Vs5
1497+
methods:
1498+
track: true
1499+
identify: true
1500+
group: true
1501+
alias: true
1502+
screen: false
1503+
page: true
1504+
platforms:
1505+
browser: true
1506+
mobile: false
1507+
server: true
1508+
warehouse: false
1509+
components: []
1510+
browserUnbundlingSupported: false
1511+
browserUnbundlingPublic: false
1512+
replay: false
1513+
settings:
1514+
- name: api_password
1515+
type: password
1516+
defaultValue: ''
1517+
description: Your Emarsys API password.
1518+
required: true
1519+
label: API password
1520+
- name: api_user
1521+
type: string
1522+
defaultValue: ''
1523+
description: Your Emarsys API username
1524+
required: true
1525+
label: API username
1526+
actions:
1527+
- id: 4B74JFPVbmV8VWe257mDAh
1528+
name: Add to Contact List
1529+
slug: addToContactList
1530+
description: >-
1531+
Add a contact to a contact list. The contact must exist before it can
1532+
be added.
1533+
platform: CLOUD
1534+
hidden: false
1535+
defaultTrigger: null
1536+
fields:
1537+
- id: 2KFQ87nWKzzs4zXUuCwDiR
1538+
sortOrder: 0
1539+
fieldKey: contactlistid
1540+
label: Id of the contact list
1541+
type: INTEGER
1542+
description: The Id of the contactlist
1543+
placeholder: ''
1544+
required: true
1545+
multiple: false
1546+
choices: null
1547+
dynamic: true
1548+
allowNull: false
1549+
- id: 6FKVH6rv9Fdzzqwpjw29EH
1550+
sortOrder: 1
1551+
fieldKey: key_field
1552+
label: Key field
1553+
type: STRING
1554+
description: The field to use to find the contact
1555+
placeholder: ''
1556+
required: true
1557+
multiple: false
1558+
choices: null
1559+
dynamic: true
1560+
allowNull: false
1561+
- id: gUHA2Sw6QS1qHositTr68n
1562+
sortOrder: 2
1563+
fieldKey: key_value
1564+
label: Key value
1565+
type: STRING
1566+
description: >-
1567+
Value for the key field used to find the contact. E.g. the email
1568+
address
1569+
placeholder: ''
1570+
required: true
1571+
multiple: false
1572+
choices: null
1573+
dynamic: false
1574+
allowNull: false
1575+
- id: a6W5k4ZAVewHSF6vwRxtX8
1576+
sortOrder: 3
1577+
fieldKey: enable_batching
1578+
label: Enable Batching?
1579+
type: BOOLEAN
1580+
description: When enabled, Segment will send events in batches.
1581+
defaultValue: false
1582+
required: false
1583+
multiple: false
1584+
choices: null
1585+
dynamic: false
1586+
allowNull: false
1587+
- id: arn7JhoTDPGbdjGYrqRJGL
1588+
name: Remove from Contact List
1589+
slug: removeFromContactList
1590+
description: Remove a contact from a contact list.
1591+
platform: CLOUD
1592+
hidden: false
1593+
defaultTrigger: null
1594+
fields:
1595+
- id: 81tEzD915VCC9kzATNBC8r
1596+
sortOrder: 0
1597+
fieldKey: contactlistid
1598+
label: Id of the contact list
1599+
type: INTEGER
1600+
description: The Id of the contactlist
1601+
placeholder: ''
1602+
required: true
1603+
multiple: false
1604+
choices: null
1605+
dynamic: true
1606+
allowNull: false
1607+
- id: aFGFk34JoSKbqkQ5YwmRTv
1608+
sortOrder: 1
1609+
fieldKey: key_field
1610+
label: Key field
1611+
type: STRING
1612+
description: The field to use to find the contact
1613+
placeholder: ''
1614+
required: true
1615+
multiple: false
1616+
choices: null
1617+
dynamic: true
1618+
allowNull: false
1619+
- id: jKPxsvkgx55dVBqbCkTHY4
1620+
sortOrder: 2
1621+
fieldKey: key_value
1622+
label: Key value
1623+
type: STRING
1624+
description: >-
1625+
Value for the key field used to find the contact. E.g. the email
1626+
address
1627+
placeholder: ''
1628+
required: true
1629+
multiple: false
1630+
choices: null
1631+
dynamic: false
1632+
allowNull: false
1633+
- id: ij6gV2Psa5JmrKbPBdwKhK
1634+
sortOrder: 3
1635+
fieldKey: enable_batching
1636+
label: Enable Batching?
1637+
type: BOOLEAN
1638+
description: When enabled, Segment will send events in batches.
1639+
defaultValue: false
1640+
required: false
1641+
multiple: false
1642+
choices: null
1643+
dynamic: false
1644+
allowNull: false
1645+
- id: gvq4dDDTEHt8vEBSATSrzd
1646+
name: Upsert Contact
1647+
slug: upsertContact
1648+
description: Insert or update a contact on the Emarsys platform
1649+
platform: CLOUD
1650+
hidden: false
1651+
defaultTrigger: null
1652+
fields:
1653+
- id: sTDCMCmrV5TfPRYFyumHKH
1654+
sortOrder: 0
1655+
fieldKey: key_field
1656+
label: Key field
1657+
type: STRING
1658+
description: The field to use to find the contact
1659+
placeholder: ''
1660+
required: true
1661+
multiple: false
1662+
choices: null
1663+
dynamic: true
1664+
allowNull: false
1665+
- id: jJnaTFAez69wvyhMWKhz26
1666+
sortOrder: 1
1667+
fieldKey: key_value
1668+
label: Key value
1669+
type: STRING
1670+
description: >-
1671+
Value for the key field used to find the contact. E.g. the email
1672+
address
1673+
placeholder: ''
1674+
required: true
1675+
multiple: false
1676+
choices: null
1677+
dynamic: false
1678+
allowNull: false
1679+
- id: pK7w67acvdfeVLtaF5XWDg
1680+
sortOrder: 2
1681+
fieldKey: write_field
1682+
label: Fields to write
1683+
type: OBJECT
1684+
description: >-
1685+
Use the emarsys field id (number) as key and set a value (string)
1686+
(static, function or event variable)
1687+
placeholder: ''
1688+
defaultValue:
1689+
'1':
1690+
'@path': $.traits.firstName
1691+
'2':
1692+
'@path': $.traits.lastName
1693+
'3':
1694+
'@path': $.traits.email
1695+
required: true
1696+
multiple: false
1697+
choices: null
1698+
dynamic: false
1699+
allowNull: false
1700+
- id: aebV1NsboiEiYH5riVLT8V
1701+
sortOrder: 3
1702+
fieldKey: enable_batching
1703+
label: Enable Batching?
1704+
type: BOOLEAN
1705+
description: When enabled, Segment will send events in batches.
1706+
defaultValue: false
1707+
required: false
1708+
multiple: false
1709+
choices: null
1710+
dynamic: false
1711+
allowNull: false
1712+
- id: niQGHcuUUEF12e4mUcCrb8
1713+
name: Trigger Event
1714+
slug: triggerEvent
1715+
description: >-
1716+
Trigger an external event on the Emarsys platform to launch automation
1717+
programs. Note: You can only pass objects to event_payload (no
1718+
literals, no arrays).
1719+
platform: CLOUD
1720+
hidden: false
1721+
defaultTrigger: null
1722+
fields:
1723+
- id: irsdijZa3jwtTtaftiTX8m
1724+
sortOrder: 0
1725+
fieldKey: eventid
1726+
label: Id of the external event
1727+
type: INTEGER
1728+
description: The Id of the external event
1729+
placeholder: ''
1730+
required: true
1731+
multiple: false
1732+
choices: null
1733+
dynamic: true
1734+
allowNull: false
1735+
- id: cq8oEgnEYrtEZWsVrd6uac
1736+
sortOrder: 1
1737+
fieldKey: key_field
1738+
label: Key field
1739+
type: STRING
1740+
description: The field to use to find the contact
1741+
placeholder: ''
1742+
required: true
1743+
multiple: false
1744+
choices: null
1745+
dynamic: true
1746+
allowNull: false
1747+
- id: dgSq36dekQp2d9y6rXSDCV
1748+
sortOrder: 2
1749+
fieldKey: key_value
1750+
label: Key value
1751+
type: STRING
1752+
description: >-
1753+
Value for the key field used to find the contact. E.g. the email
1754+
address
1755+
placeholder: ''
1756+
required: true
1757+
multiple: false
1758+
choices: null
1759+
dynamic: false
1760+
allowNull: false
1761+
- id: bgo5onHT3jrwyPyzY9na4
1762+
sortOrder: 3
1763+
fieldKey: event_payload
1764+
label: Event payload
1765+
type: OBJECT
1766+
description: >-
1767+
A JSON object that will be passed to the Emarsys template engine
1768+
and can be used for personalization
1769+
placeholder: ''
1770+
required: false
1771+
multiple: false
1772+
choices: null
1773+
dynamic: false
1774+
allowNull: true
1775+
- id: gZZaRUnB1sc5LFPWgnHPKG
1776+
sortOrder: 4
1777+
fieldKey: enable_batching
1778+
label: Enable Batching?
1779+
type: BOOLEAN
1780+
description: When enabled, Segment will send events in batches.
1781+
defaultValue: false
1782+
required: false
1783+
multiple: false
1784+
choices: null
1785+
dynamic: false
1786+
allowNull: false
1787+
presets: []

‎src/connections/destinations/catalog/actions-emarsys/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Emarsys (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: false
5+
private: true
6+
id: 63f65c1c42e3bded41f0499c
7+
versions:
8+
- name: Emarsys (Classic)
9+
link: /docs/connections/destinations/emarsys
10+
---
11+
{% include content/plan-grid.md name="actions" %}
12+
13+
[Emarsys](https://www.emarsys.com){:target="_blank"} Emarsys, An SAP Company, is the omnichannel customer engagement platform, which empowers marketers to build, launch, and scale personalized cross-channel campaigns that drive business outcomes. By rapidly aligning desired business results with proven omnichannel customer engagement strategies the platform enables marketers to accelerate time to value, deliver superior 1:1 experiences and produce measurable results fast.
14+
15+
16+
## Benefits of Emarsys (Actions) vs Emarsys Classic
17+
18+
Emarsys (Actions) provides the following benefits over the classic Emarsys destination:
19+
20+
- **Easy self-setup**. Use standard API credentials to connect to an Emarsys account.
21+
- **Standard actions**. Use standard API functionality to manage contacts and start marketing automations.
22+
23+
24+
## Getting Started
25+
26+
1. In the Segment web app, go to **Catalog** > **Destinations**.
27+
2. In the left menu, click Destination Actions.
28+
3. Click **Configure Actions Emarsys**.
29+
4. Select an existing Source to connect to Emarsys (Actions).
30+
5. Click Customized Setup to start with an empty mapping.
31+
32+
## Important differences compared to the classic Emarsys destination
33+
34+
The classic Emarsys destination handles any kind of Segment traffic but it requires additional configuration in the Emarsys account. Emarsys (Actions) does not need additional configuration in the Emarsys account, it is only configured in the Segment user interface.
35+
Please note that standard API rate limits apply.
36+
37+
{% include components/actions-fields.html %}
38+

0 commit comments

Comments
 (0)