/firestore-send-msg

Source code for MessageBird Firebase send message extension

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Send Messages with MessageBird

ci

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.

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.

  • 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.)