Firebase Integration

Firebase is available as an Action Type in Fast Track. By following the steps below you can integrate this engagement channel.

🏛 Architecture

Here is a diagram describing the implementation.

Firebase architecture

🔚 Endpoints to link and unlink tokens

As described in the diagram above, we will need you to send the firebase token/tokens to these endpoints below when it gets linked/unlinked to a user. You can also publish messages on the RabbitMQ with the specified notification type.

REST API

⬆️ POST /v1/integration/user/device/link

RabbitMQ Connector

RabbitMQ Message Properties

key	value
type	USER_DEVICE_LINK

The type is expected as a property (but not in the payload) of the RabbitMQ Message. Any header will be ignored.

Kafka Connector

Kafka Message Headers

key	value
type	USER_DEVICE_LINK

{
    "user_id": "1234",
    "origin": "yoursite.com",
    "tokens": [
        {
            "token": "abc",
            "channel": "android",
            "provider": "firebase"
        },
        {
            "token": "abc",
            "channel": "ios",
            "provider": "firebase"
        },
        {
            "token": "abc",
            "channel": "web",
            "provider": "firebase"
        }
    ],
    "timestamp": "2019-09-12T10:00:00Z"
}

REST API

⬆️ POST /v1/integration/user/device/unlink

RabbitMQ Connector

RabbitMQ Message Properties

key	value
type	USER_DEVICE_UNLINK

The type is expected as a property (but not in the payload) of the RabbitMQ Message. Any header will be ignored.

Kafka Connector

Kafka Message Headers

key	value
type	USER_DEVICE_UNLINK

{
    "user_id": "1234",
    "origin": "yoursite.com",
    "tokens": [
        {
            "token": "abc",
            "channel": "android",
            "provider": "firebase"
        },
        {
            "token": "abc",
            "channel": "ios",
            "provider": "firebase"
        },
        {
            "token": "abc",
            "channel": "web",
            "provider": "firebase"
        }
    ],
    "timestamp": "2019-09-12T10:00:00Z"
}

Credentials

We will need you to provide us with credentials described in below link.

Send a Message using FCM HTTP v1 API  |  Firebase Cloud MessagingFirebase

Best Practises for Token Management

You manage how the tokens are stored in Fast Track by using the LINK / UNLINK events (see above). Please read this article from Firebase containing Best Practise examples:

Best practices for FCM registration token management  |  Firebase Cloud MessagingFirebase