CampaignCanvas

Integrations

Connect contact activity in CampaignCanvas to other systems. Contact events appear in Umbraco’s own Webhooks list, and the CampaignCanvas.Automate package adds triggers and actions to Umbraco Automate.

Umbraco webhook events

CampaignCanvas registers three events with Umbraco’s built-in webhooks. Create a webhook under Settings → Webhooks in the backoffice and pick one or more of these events:

EventWhen it fires
CampaignCanvas: Contact CreatedA new contact is added to your database.
CampaignCanvas: Contact Subscribed to ListA contact’s membership becomes Subscribed — immediately on a single opt-in list, or when the confirmation link is clicked on a double opt-in list.
CampaignCanvas: Contact Unsubscribed from ListA contact opts out of a list.

Payload

Every event carries the contact:

  • contactId, email, firstName, lastName, language, tags
  • occurredUtc— when the change happened

The subscribe and unsubscribe events also include:

  • listId, listName, listAlias — the list that changed
  • reason— the unsubscribe reason, when one was given (unsubscribe only)
  • lists— the contact’s status on every non-archived list, each with listId, listName, listAlias and status (Subscribed, PendingConfirmation, Unsubscribed, Bounced or None)
Bulk changes don’t fire events

CSV imports and bulk add/remove actions raise no per-contact events, so a large import doesn’t flood your webhook endpoint.

Umbraco Automate

The separate CampaignCanvas.Automatepackage adds CampaignCanvas to Umbraco Automate’s step catalogue: form submissions and contact activity can start an automation, and contacts can be looked up, created, subscribed and unsubscribed as steps inside one.

Install

Requires Umbraco 17.4 or later, Umbraco Automate, and .NET 10.

dotnet add package CampaignCanvas.Automate

The steps register themselves on the next start — there’s nothing to configure. Automate runs automations as a workspace service account; give that account access to the CampaignCanvas section, or the steps won’t be available to it. The actions need a CampaignCanvas licence (see Licence gating).

Triggers

TriggerFires when
Form SubmittedThe form you pick receives a successful submission. Its fields become bindings, e.g. ${ trigger.fields.email }. Spam-rejected and invalid submissions never fire.
Contact CreatedA new contact is added to your database.
Contact Subscribed to ListA contact becomes active on a list — immediately on single opt-in, or on the confirmation click for double opt-in. Filter to one list or leave it open.
Contact Unsubscribed from ListA contact opts out, with the reason where one was given. Also filterable by list.

As with webhooks, bulk imports and bulk list changes raise nothing per contact.

Actions

ActionWhat it does
Find Contact by EmailRead-only lookup, so you can branch on whether the address is already known.
Create or Update ContactCreates the contact or updates the one holding the address. Blank fields are left alone; tags are added without removing existing ones.
Subscribe Contact to ListAdds a contact to a list, creating them if the address is new, and records the consent source as automate:<id>. Honours the list’s double opt-in setting: on a DOI list the contact starts pending and receives the confirmation email. A contact who unsubscribed from that list, or whose address bounced, is skipped unless you tick Re-subscribe contacts who opted out under Advanced.
Unsubscribe Contact from ListOpts a contact out of one list, with a reason. Other memberships are untouched.

Worth knowing

  • Actions raise triggers. Create or Update Contact raises Contact Created, and Subscribe Contact to List raises Contact Subscribed to List. Every contact trigger has a When triggered by another automation setting under Advanced, which defaults to Skip if this would loop.
  • Deleted forms and lists fail loudly.A trigger whose form was deleted stops firing; an action whose list was deleted fails with a configuration error. Both show in Automate’s run log.
  • Form values are untrusted. An email bound from a public form decides whose contact record is updated, and subscribing it sends mail to that address. Point public-facing automations at a double opt-in list, and only tick Re-subscribe contacts who opted out for addresses from a source you trust.
  • Submission data is copied to Automate.Form Submitted carries the submitted values and the submitter’s IP address into Automate’s run history, which has its own retention and permissions. Account for it in your retention policy.