Connect Apsis One

With the Apsis One integration, everyone who signs up is created or updated as a profile in Apsis One, in the section you choose, and can be opted in to one of your Apsis One subscriptions.

What you need

• An Apsis One account, and a user who can manage API keys (usually an administrator).
• To know whether your Apsis One account is in the Europe or Asia region. Most accounts are in Europe.

Step 1: Create an API key in Apsis One

1. In Apsis One, open Account settings and go to API keys (under integrations).
2. Click to create a new API key. Give it a name you recognise, for example "Scratcher".
3. Give the key access to the section or sections you want Scratcher to send profiles to, with the permissions below.
4. Save, and copy the Client ID and the Client secret. The secret is only shown once.

Apsis has its own step-by-step guide for this. It's linked from the Setup guide in the install dialog in Scratcher ("To install the integration, follow the guide here").

Permissions the key needs

Scratcher uses the key to:

• read your sections, and the attributes, subscriptions (consent topics) and events in them, so you can choose them in the campaign;
• create profiles and update their attributes;
• add consents (opt-ins) to profiles;
• add events to profiles.

So the key needs read access to sections and write access to profiles, consents and events in the sections you use. Without write access, deliveries fail with Apsis One's own error message.

Step 2: Connect Apsis One to Scratcher

1. In Scratcher, go to Settings > Integrations and click Apsis One.
2. Choose the API region: Europe or Asia.
3. Paste the Client ID and Client secret.
4. Click Install integration. Scratcher logs in to Apsis One to check the details.

Step 3: Turn it on in a campaign

1. In the editor, go to Connect > Integrations > Apsis One and click Activate.
2. If you have connected more than one Apsis One account, choose it under Select account.
3. Under Apsis section, choose the section (Select a section).
4. Under Field mappings, click Add field mapping for each field and match the Scratcher field to the Apsis One attribute in Destination field. The list shows the attributes of the section you chose, including your own.
5. Under Subscriptions (consents), choose the subscription people should be opted in to, or None. "Choose any subscription that the participant should be opted into."
6. Under Filter by permissions (optional), choose your marketing consent checkbox, so only people who ticked it are sent.
7. Click Save, and then Test to send a test profile.

Field mapping

• The email address is always sent and is used to identify the profile. You don't need to map it.
• For phone numbers, use the Format setting to send the number the way your attribute expects.
• Yes/no attributes get true or false, so map a consent's Accepted field to a yes/no attribute.

Consent

If you choose a subscription, each person is opted in to it with the reason "Subscribed via" and the campaign name, and the source "Scratcher". If the person is already opted in, nothing changes. Use Filter by permissions so only people who ticked your marketing checkbox are opted in.

If your section has Apsis One's consent form event, Scratcher also records the sign-up as an event on the profile, with the campaign's address.

What is sent and when

New sign-ups are sent within a minute or two. When you activate the integration, the campaign's existing leads are sent too. When someone takes part again, their profile is updated. Check every delivery under Settings > Integrations > Delivery status; it also shows whether the profile was new or already existed. See Check the delivery status and resend leads.

Troubleshooting

• "All or some of the fields are invalid..." when installing: check the region, and copy the client ID and secret again.
• Deliveries fail with an access error from Apsis One: the key doesn't have access to the section, or lacks write permissions. Edit the key in Apsis One.
• Subscriptions (consents) is empty: the section has no subscriptions yet. Create one in Apsis One and open the integration again.