Skip to content
Optima docs
ConsoleChannels

Custom channels

Declare a channel of your own, such as a call centre or a print bureau, so consent, campaigns and suppression treat it like a built-in channel.

The built-in channels cover email, SMS, RCS, WhatsApp, Viber, push and webhooks. If your organisation also contacts people another way, such as a call centre, an IVR dialler or a print bureau, you declare that channel here. Once declared, a consent purpose can be limited to it, the preference centre can offer it, and when someone withdraws consent or asks to be erased, the right contact is suppressed for that channel. A declared channel delivers nothing by itself: you also give it a provider that carries the request. Custom channels are managed in the Custom channels card at the bottom of Settings → Integrations → Channels.

Who uses it

Integration specialists declare channels. Reading needs the integration_viewer role; creating, editing and deleting need integration_editor (or campaign_admin), or another role your administrator has given access to this area — see Licences and roles. The screen is part of the Campaign package (the delivery channels feature).

Note:

Declaring a channel is half the job. Until a provider exists for it, nothing delivers on that channel. Once the channel is active it gets its own card on the Delivery channels screen; add an http provider there with the URL, method, headers, authentication and payload template of your service.

Fields

Each declared channel is listed with its display name, its name, how it addresses a person, and an inactive badge when it is switched off. The New channel and Edit channel dialog:

FieldMeaningValid valuesDefault
NameThe value stored on campaigns, consent purposes and touches. Fixed after creation, because renaming would orphan everything scoped to the old name. Required.Lowercase letters, digits and underscores, for example call_centerEmpty
Display nameHow the channel is shown in the console.Text, for example Call centreThe name
How it addresses a personWhich kind of contact the channel uses. A custom channel picks one of the four existing kinds; it cannot invent a fifth, which is what lets contact lookup and suppression work unchanged.Email address, Phone number, Device token, No personal contactNo personal contact
Identifier keysWhich profile identifiers to try, in order. Shown for Email address and Phone number only; optional.Comma-separated names, for example phone, phone_number, msisdnThe kind's defaults: email, or phone, phone_number, msisdn
Template fieldsWhich built-in message layout the channel's templates use.A built-in channel namewebhook (a single body)
ActiveWhether the channel can be used for new things.On or offOn

Actions

  • New channel opens the dialog.
  • Edit channel (pencil) changes everything except the name.
  • Delete channel (bin) removes it after confirmation. Consent purposes, campaigns, templates and fatigue policies that still name it must be pointed elsewhere first. To stop new use without breaking them, deactivate the channel instead.

Examples

A call centre. Name call_center, display name Call centre, contact Phone number, identifier keys phone, mobile, template fields webhook. Then add an http provider on the new Call centre card that posts the call task to your dialler, and create a consent purpose limited to call_center.

Common problems

  • Nothing is delivered. The channel has no provider. The card says so; add one.
  • Name rejected. Use lowercase letters, digits and underscores only.
  • Delete refused. Something still uses the channel; repoint it or deactivate the channel.

On this page