Important
Please be aware that the notifications only can be triggered by events and cannot be used as entitlements.
Important
This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements.
HelloID-Conn-Prov-Notification-MessageBirdSMS is a notifcation connector. MessageBird provides a set of REST APIs that allow you to programmatically interact with its data. The MessageBird SMS API documentation provides details of API commands that are used.
- API AccessKey from MessageBird
The following settings are required to connect to the API.
Setting | Description | Mandatory |
---|---|---|
BaseUri | The BaseURI of the Messagebird API endpoint(s) | Yes |
AccessKey | AccessKey for Messagebird API. Follow the MessageBird Tutorial on how to create the access key | Yes |
Sending From | The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters | Yes |
There is one templates.
Please keep in mind that the key form field names in the templates are used in the notification.ps1 changing them will break the connector. |
It is possible to hide or disable (make them read-only) certain form fields if they are not used or should not be changed. For example, the scriptFlow should always be 'SMS' and the field must be hidden in the configuration:
{
"key": "scriptFlow",
"type": "input",
"defaultValue": "SMS",
"templateOptions": {
"label": "Script flow",
"disabled": false
},
"hide": true
},
To create a form for SMS the following template should be used: template.json.
The table below describes the different form fields from the template.
template key | Description | Mandatory |
---|---|---|
scriptFlow | Fixed value "SMS" (read-only) | Yes |
Time | Optional, the scheduled time of the message in format HH:mm:ss | Yes |
Recipient mobile number | Mobile number where SMS should be delivered | Yes |
Recipient name | Name of the recipient | No |
Message | Body of the SMS Message | Yes |
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages
If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/