[Dotdigital] Add actions for Add Contact to List, Remove Contact From List, and Enrol Contact #2871
Conversation
…nation at 2025-04-15T11:38:52Z by:Shaun Hogan
github-actions
bot
added
deploy:push
deploy:registration
mode:cloud
team:external
labels
pvpcookie
changed the title
|
Hi @pvpcookie thanks for the PR for a new Integration! Kind regards, |
| import addContactToList from './addContactToList' | ||
| const destination: DestinationDefinition<Settings> = { | ||
| name: 'Dotdigital', | ||
| slug: 'actions-dotdigital', |
There was a problem hiding this comment.
Please add a 1 line description explaining what the Integration does.
| password: { | ||
| label: 'Password', | ||
| description: 'Your Dotdigital password.', | ||
| type: 'string', |
There was a problem hiding this comment.
| type: 'string', | |
| type: 'password', |
| label: 'Email Address', | ||
| description: "The contact's email address.", | ||
| type: 'string', | ||
| unsafe_hidden: true, |
There was a problem hiding this comment.
hi @pvpcookie are you aware that this field will be hidden from the user regardless of whether or not the customer selects email as the Channel Identifier?
I think you should remove the unsafe_hidden: true line. The field will display if the depends_on condition is met.
| label: 'Mobile Number', | ||
| description: "The contact's mobile number.", | ||
| type: 'string', | ||
| unsafe_hidden: true, |
There was a problem hiding this comment.
I think you should remove the unsafe_hidden: true line. The field will display if the depends_on condition is met.
| if (!listId) { | ||
| throw new PayloadValidationError('List id is required') | ||
| } |
There was a problem hiding this comment.
Nit: Probably not needed. Payloads without a listId value will get dropped before the perform() function is called.
| if (!identifierValue) { | ||
| throw new PayloadValidationError( | ||
| channelIdentifier === 'email' ? 'Email address is required' : 'Mobile number is required' | ||
| ) | ||
| } |
There was a problem hiding this comment.
Nit: Same with this - there should always be an identifierValue as email the email or mobile fields will be populated. So this check probably not needed.
| defaultObjectUI: 'keyvalue:only', | ||
| additionalProperties: false, | ||
| dynamic: true |
There was a problem hiding this comment.
hi @pvpcookie - I think there's some conflicting configuration here.
defaultObjectUI: 'keyvalue:only' - this means that the UI will only let the customer configure key:value pairs in the object, rather than passing the entire object in a single go.
additionalProperties: false - this will prevent the customer from adding new key:value items.
The net result of this is that only a single key:value pair will be configurable - that is assuming the UI will actually implement the config as expected.
I think this the following is what you actually want:
- allow the customer to add many key:value pairs to the dataFields object, one at a time. Each time the customer selects to add a new item the dynamic function will be called and will populate the list of keys the customer can select from.
To achieve this I think you chould remove the additionalProperties: false configuration.
| const action: ActionDefinition<Settings, Payload> = { | ||
| title: 'Add Contact to List', | ||
| description: '', | ||
| defaultSubscription: 'type = "identify"', |
There was a problem hiding this comment.
It might be worth considering if an identify() call is the best way to do this. I would recommend a defaultSubscription that looks for a track() event. For example:
defaultSubscription: 'type = "track" and event="Added To List"',
| const action: ActionDefinition<Settings, Payload> = { | ||
| title: 'Remove Contact from List', | ||
| description: '', | ||
| defaultSubscription: 'type = "identify"', |
There was a problem hiding this comment.
It might be worth considering if an identify() call is the best way to do this. I would recommend a defaultSubscription that looks for a track() event. For example:
defaultSubscription: 'type = "track" and event="Removed From List"',
|
hi @pvpcookie and @simon-letch thanks for the PR. I reviewed what I could but I have some architectural questions I'd like to discuss with you in person, just to ensure that this Integration is designed in an optimal way. Would it be possible to schedule a call with me? I'm based in Ireland - I see that you are both based in the UK and SA so our timezones overlap well. The main things I'd like to discuss are:
Please reply in this PR with 2-3 times which would work for us to connect on Tuesday or Wednesday this week. Usually this type of discussion needs about 1h. We can have a follow up too if needed. Kind regards, |
What's New
We have added three new actions as part of the initial release for the Dotdigital action destination in Segment IO:
Remove Contact from List
This action is used to remove a contact from a list they were previously subscribed to.
Enroll Contact
This action is used to enroll a contact into an automation program in Dotdigital.
Add Contact to List
This action is intended to add or update a contact in Dotdigital.
Why This Was Changed / Added
We are expanding the scope of available actions for the Dotdigital platform.
How to Review / Test This Change
Run the following commands: