Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tools4everbv/helloid-conn-prov-notification-messagebirdsms
MessageBird Notification System
https://github.com/tools4everbv/helloid-conn-prov-notification-messagebirdsms
cloud notification on-premises pnc powershell provisioning sms
Last synced: 3 days ago
JSON representation
MessageBird Notification System
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-conn-prov-notification-messagebirdsms
- Owner: Tools4everBV
- Created: 2023-08-11T10:12:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-13T08:02:18.000Z (5 months ago)
- Last Synced: 2024-11-10T22:33:23.885Z (2 months ago)
- Topics: cloud, notification, on-premises, pnc, powershell, provisioning, sms
- Language: PowerShell
- Homepage:
- Size: 156 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HelloID-Conn-Prov-Notification-MessageBirdSMS
> [!IMPORTANT]
> Please be aware that the notifications only can be triggered by [events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notification-events--provisioning-.html) 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.
## Table of contents
## Introduction
_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](https://developers.messagebird.com/api/sms-messaging/#api-endpoint) provides details of API commands that are used.
## Table of contents
- [HelloID-Conn-Prov-Notification-MessageBirdSMS](#helloid-conn-prov-notification-messagebirdsms)
- [Table of contents](#table-of-contents)
- [Introduction](#introduction)
- [Table of contents](#table-of-contents-1)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Connection settings](#connection-settings)
- [Templates](#templates)
- [SMS](#sms)
- [Getting help](#getting-help)
- [HelloID docs](#helloid-docs)
## Getting started
### Prerequisites
- API AccessKey from MessageBird
### Connection settings
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](https://developers.messagebird.com/tutorials/getting-started-101/) | 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 |
### Templates
There is one templates.
| :warning: Warning |
| :------------------------------------------------------------------------------------------------------------------------------------------ |
| |
| 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:
```JSON
{
"key": "scriptFlow",
"type": "input",
"defaultValue": "SMS",
"templateOptions": {
"label": "Script flow",
"disabled": false
},
"hide": true
},
```
#### SMS
To create a form for SMS the following template should be used: [template.json](https://github.com/Tools4everBV/HelloID-Conn-Prov-Notification-MessageBirdSMS/blob/main/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 |
## Getting help
> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notification-systems--provisioning-) pages_
> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com/forum/helloid-connectors/provisioning/4929-helloid-conn-prov-notification-messagebirdsms)_
## HelloID docs
> The official HelloID documentation can be found at: https://docs.helloid.com/