https://github.com/messagebird/firestore-send-msg

Source code for MessageBird Firebase send message extension
https://github.com/messagebird/firestore-send-msg

Last synced: 5 months ago
JSON representation

Source code for MessageBird Firebase send message extension

• Host: GitHub
• URL: https://github.com/messagebird/firestore-send-msg
• Owner: messagebird
• License: apache-2.0
• Created: 2020-05-07T11:11:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T22:04:14.000Z (almost 3 years ago)
• Last Synced: 2024-03-26T12:20:22.965Z (over 2 years ago)
• Language: TypeScript
• Homepage:
• Size: 885 KB
• Stars: 11
• Watchers: 9
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Send Messages with MessageBird

![ci](https://github.com/messagebird/firebase-extensions/workflows/ci/badge.svg)

**Description**: Creates and sends messages and notifications using the MessageBird Conversations API.

Extension is triggered when document written to a specified Cloud Firestore collection. It will try to deliver your message based on document contents and update it with status.

**Tutorial:**

For a detailed run through in how to install and use the extension please see the following [blog post](https://blog.messagebird.com/posts/get-started-with-the-messagebird-extension-on-firebase).

**Configuration Parameters:**

* Cloud Functions location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

* MessageBird Access Key: A MessageBird's REST api access key

* Collection name that will be used to store messages that should be sent: What is the path to the collection that contains the documents used to build and send the messages?

* Log level: Log level, can be one of "info"/"warn", default is "warn"

**Cloud Functions:**

* **processQueue:** Processes document changes in the specified Cloud Firestore collection, delivers messages, and updates the document with delivery status information.

**Access Required**:

This extension will operate with the following project IAM roles:

* datastore.user (Reason: Allows this extension to access Cloud Firestore to read and process added documents.)