This is the official Python library for communicating with Engagespot REST API. Send multi-channel notifications from your python app.
# Installation
```
pip install engagespot
```
# Prerequisites
You need Engagespot API KEY and API SECRET from your [dashboard](https://console.engagespot.co) to get started. If you don't have one, just get one for free.
# Creating or updating a user
Before you can send a notification, you should create the user (recipient) profile in Engagespot.
```python
from engagespot import Engagespot
client = Engagespot(api_key="ENGAGESPOT_API_KEY", api_secret="ENGAGESPOT_API_SECRET", data_region="us")
user_profile = {
"name" : "Python User",
"email" : "python@engagespot.co",
"phoneNumber": "+1620000000"
}
response = client.create_or_update_user("user-identifier");
```
<i>`data_region` can be either `us` or `eu` depending on your workspace data region</i>
# Triggering a workflow
The easiest way to send notifications in Engagespot is by creating message workflows in [Engagespot console](https://console.engagespot.co) and trigger it using this Python library.
```python
from engagespot import Engagespot
client = Engagespot(api_key="ENGAGESPOT_API_KEY", api_secret="ENGAGESPOT_API_SECRET", data_region="us")
send_request = {
"notification": {
"workflow":{
"identifier":"welcome-message-workflow"
}
},
"sendTo":{
"recipients": ["user-identifier"]
}
}
response = client.send(send_request)
```
Refer [Engagespot REST API Docs](https://docs.engagespot.co/docs/rest-api) to get the list of all supported parameters.
# Detailed Guide
Read [Engagespot docs](https://docs.engagespot.co/docs/introduction/quick-start) to learn how to build and send notification workflows.
Raw data
{
"_id": null,
"home_page": "https://github.com/Engagespot/engagespot-python",
"name": "engagespot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Anand",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f2/a5/2744968ea71cac29682b1f90faf13612cc808f290f89c1c81ed68145d6f0/engagespot-1.1.0.tar.gz",
"platform": null,
"description": "This is the official Python library for communicating with Engagespot REST API. Send multi-channel notifications from your python app.\n\n# Installation\n\n```\npip install engagespot\n```\n\n# Prerequisites\nYou need Engagespot API KEY and API SECRET from your [dashboard](https://console.engagespot.co) to get started. If you don't have one, just get one for free.\n\n# Creating or updating a user\n\nBefore you can send a notification, you should create the user (recipient) profile in Engagespot.\n\n```python\nfrom engagespot import Engagespot\n\nclient = Engagespot(api_key=\"ENGAGESPOT_API_KEY\", api_secret=\"ENGAGESPOT_API_SECRET\", data_region=\"us\")\n\nuser_profile = {\n \"name\" : \"Python User\",\n \"email\" : \"python@engagespot.co\",\n \"phoneNumber\": \"+1620000000\"\n}\n\nresponse = client.create_or_update_user(\"user-identifier\");\n```\n\n<i>`data_region` can be either `us` or `eu` depending on your workspace data region</i>\n\n# Triggering a workflow\n\nThe easiest way to send notifications in Engagespot is by creating message workflows in [Engagespot console](https://console.engagespot.co) and trigger it using this Python library.\n\n```python\nfrom engagespot import Engagespot\n\nclient = Engagespot(api_key=\"ENGAGESPOT_API_KEY\", api_secret=\"ENGAGESPOT_API_SECRET\", data_region=\"us\")\n\nsend_request = {\n \"notification\": {\n \"workflow\":{\n \"identifier\":\"welcome-message-workflow\"\n }\n },\n \"sendTo\":{\n \"recipients\": [\"user-identifier\"]\n }\n}\n \nresponse = client.send(send_request)\n```\n\nRefer [Engagespot REST API Docs](https://docs.engagespot.co/docs/rest-api) to get the list of all supported parameters.\n\n\n# Detailed Guide\nRead [Engagespot docs](https://docs.engagespot.co/docs/introduction/quick-start) to learn how to build and send notification workflows.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for communicating with Engagespot REST API.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/Engagespot/engagespot-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdd4adb7d8804b3f5604a5c85cccc6f92bc3ce24544a249b5356ad89482036a2",
"md5": "bdf71d6f219c779c9a38a47575cd97ac",
"sha256": "196809c3bca3c76585d8c9c144e538c69ed6af5661e97a0f7ce9b67b8684bfcf"
},
"downloads": -1,
"filename": "engagespot-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdf71d6f219c779c9a38a47575cd97ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4367,
"upload_time": "2024-11-07T07:09:51",
"upload_time_iso_8601": "2024-11-07T07:09:51.766621Z",
"url": "https://files.pythonhosted.org/packages/bd/d4/adb7d8804b3f5604a5c85cccc6f92bc3ce24544a249b5356ad89482036a2/engagespot-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2a52744968ea71cac29682b1f90faf13612cc808f290f89c1c81ed68145d6f0",
"md5": "0563393873ef6945ba596e23f2294344",
"sha256": "27209ac5b1451fb02547985b35e37b514bb5bc215c214acd1c57a4bae0422ed5"
},
"downloads": -1,
"filename": "engagespot-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0563393873ef6945ba596e23f2294344",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3791,
"upload_time": "2024-11-07T07:09:54",
"upload_time_iso_8601": "2024-11-07T07:09:54.230266Z",
"url": "https://files.pythonhosted.org/packages/f2/a5/2744968ea71cac29682b1f90faf13612cc808f290f89c1c81ed68145d6f0/engagespot-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 07:09:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Engagespot",
"github_project": "engagespot-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.24.0"
]
]
}
],
"lcname": "engagespot"
}
JSON
