Custom Services
The following describes how to add custom service integrations.
Add Custom Service
鈫� 鈫� 鈫� 鈫� 鈫�
To add a custom service:
From the Custom Services homepage, select Add Custom Service.
From the menu pane on the left, select a page and define the respective settings.
The following introduces the pages of the Custom Services editor.
Page
Description
Define general settings, including its name and description. Other settings are specific to the service type.
Optionally add custom sections and unique input fields to capture additional information or settings for the service.
The custom fields are added to the Custom Service section of the Sites editor.
General
鈫� 鈫� 鈫� 鈫� 鈫�
From the General page of the Custom Service editor, define the following settings:
Setting | Description |
|---|---|
Service Name | Name of the service. |
Description | Description of the service. |
Service URL | Integrator-provided URL this service uses to communicate. |
Type | From the dropdown, select the service type. |
Service Types
Type | Description |
|---|---|
Custom | Custom service. |
Delivery | Delivery service via mobile app or website. Define the following additional setting:
|
Gift Provider | Gift card service provider. Once created, assign the service to a gift provider profile in Data Management. See Gift Provider Profiles. Once the service is assigned to a profile, the service properties cannot be changed. |
Loyalty | Customer loyalty program service. |
Payment | Payment service. Define the following additional settings:
|
Custom Fields
鈫� 鈫� 鈫� 鈫� 鈫�
From the聽Custom Fields page of the聽Custom Services聽editor, add custom sections and input fields for a service in order to capture additional information or settings.
Add Section
To add a section:
From the Custom Fields page, select +Add New Section.
From the Add Section popup, type a name for the section.
Select Create.
Add as many sections as needed. The following controls are available in the upper-right of each section:
Control | Description |
|---|---|
| Edit section properties. |
| Move section up one level. |
| Move section down one level. |
| Remove section. |
Add Field to Section
Within each section, add any combination of fields. The following describes the field types:
Type | Description |
|---|---|
Enable user to select a value from a list of choices. | |
Enable user to type a value in provided field (maximum characters: 1024). | |
Enable user to toggle option on/off. |
Next to each field, the following controls are available:
Control | Description |
|---|---|
| Select and drag field to new location in section. |
| Edit field properties. |
| Remove field from section. |
Add Drop Down
To add a Drop Down field:
From inside a section, select +Add New Field.
From Add Field form, define the following:
Setting
Description
Type
From the dropdown, select Drop Down.
Label
Type a name for the field.
Help Text
Type instructions to help the user understand the purpose of the field.
Placeholder Text
Type text to display in the field when the section is first opened.
This text is replaced when the user selects a value.
Required
Toggle On if the user is required to provide a value.
Bulk Enabled
(Gift Provider service only) Toggle On if the service supports Bulk Gift Card Activation.
Parameter Key
Type the parameter name used in the API.
Field Choices
Select +Add Choice to add a value to the dropdown.
Add as many values as needed.
From the Default Choice column, select the value that is selected by default.
In the Preview section, view a preview of the field.
From the lower-right, select Save.
Add Text Entry
To add a Text Entry field:
From inside a section, select +Add New Field.
From Add Field form, define the following:
Setting
Description
Type
From the dropdown, select Text Entry.
Label
Type a name for the field.
Required
Toggle On if the user is required to provide a value.
Encrypted
Toggle Yes to encrypt the value in the database for security.
To unmask the field a user needs to click this icon (the icon has the same color as the text in a field, once a mouse hovers on it the color is blue).
Masked
Toggle Yes to mask the value on the form for security. Select the eye icon to unmask the value.
Bulk Enabled
(Gift Provider service only) Toggle On if the service supports Bulk Gift Card Activation.
Help Text
Type instructions to help the user understand the purpose of the field.
Placeholder Text
Type text to display in the field when the section is first opened.
This text is replaced when the user types a value in the field.
Parameter Key
Type the parameter name used in the API.
From the lower-right, select Save.
Add Toggle
To add a Toggle field:
From inside a section, select +Add New Field.
From Add Field form, define the following:
Setting
Description
Type
From the dropdown, select Toggle.
Label
Type a name for the field.
Default State
Specify if the field is toggled On or Off by default.
Bulk Enabled
(Gift Provider service only) Toggle On if the service supports Bulk Gift Card Activation.
On Description
Type the field description when toggled On.
Off Description
Type the field description when toggled Off.
Help Text
Type instructions to help the user understand the purpose of the field.
Parameter Key
Type the parameter name used in the API.
From the lower-right, select Save.