Skip to content

sipgate-io/io-labs-history-slack

Repository files navigation

sipgate logo

sipgate.io history slack integration

This example demonstrates how to send slack messages based on data received from sipgate.io webhooks.

For further information regarding the push functionalities of sipgate.io please visit https://developer.sipgate.io/push-api/api-reference/

Prerequisites

  • Node.js >= 10.15.3

Enabling sipgate.io for your sipgate account

In order to use sipgate.io, you need to book the corresponding package in your sipgate account. The most basic package is the free sipgate.io S package.

If you use sipgate basic or simquadrat you can book packages in your product's feature store. If you are a sipgate team user logged in with an admin account you can find the option under Account Administration > Plans & Packages.

Install dependencies:

Navigate to the project's root directory and run:

npm install

Execution

Create a webhook in your slack control panel. Details can be found in the official slack documentation.

Create the .env file by copying the .env.example. Set the values according to the comment above each variable.

The token should have the history:read scope. For more information about personal access tokens visit https://www.sipgate.io/rest-api/authentication#personalAccessToken.

Run the application:

npm start

Alternatively, you can set the environment variables as part of the shell command.

SIPGATE_TOKEN_ID=token_id SIPGATE_TOKEN=token SLACK_WEBHOOK_URL=https://your.slack.webhook.url npm start

Common Issues

web app displays "Feature sipgate.io not booked."

Possible reasons are:

  • the sipgate.io feature is not booked for your account

See the section Enabling sipgate.io for your sipgate account for instruction on how to book sipgate.io

Contact Us

Please let us know how we can improve this example. If you have a specific feature request or found a bug, please use Issues or fork this repository and send a pull request with your improvements.

License

This project is licensed under The Unlicense


sipgate.io | @sipgateio | API-doc

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published