Docs / Contact / connectors/gcp-firebase

Google Firebase Cloud Messaging

Provider: gcp | Service: firebase | Direction: Write

Firebase Cloud Messaging (FCM) connector for sending push notifications. This is a forward-only connector.

Required Permissions

The service account must have:

Operation Required Permission Predefined Role
Send cloudmessaging.messages.create Firebase Cloud Messaging Admin
Tip: Use a dedicated service account with only the Firebase Cloud Messaging Admin role. Generate the credentials JSON from the Firebase Console under Project settings > Service accounts.

Operation

When a message reaches this connector, it sends one push notification. The payload must supply:

Payload field Required Description
token Yes FCM device token for the target device
title Yes Notification title
body Yes Notification body text

Connector Configuration

The connector is created with type: "cloud", provider: "gcp", service_type: "firebase", plus:

Field (config) Required Description
auth_type No api_key (default) or role. See below.
project_id Yes Firebase project ID
credentials Conditional Firebase service account JSON credentials (use ${secrets.firebase_credentials}). Required when auth_type is api_key.
Role-based authentication

Set auth_type: "role" to use Application Default Credentials (ADC) from the environment Contact runs in. No service account JSON is needed.

Output

json

{
  "status": "completed",
  "data": {
    "status": "sent",
    "token": "fcm-device-token"
  }
}

Example

Connector config (service account):

json

{
  "type": "cloud",
  "provider": "gcp",
  "service_type": "firebase",
  "project_id": "my-firebase-project",
  "credentials": "${secrets.firebase_credentials}"
}

Connector config (ADC / role):

json

{
  "type": "cloud",
  "provider": "gcp",
  "service_type": "firebase",
  "auth_type": "role",
  "project_id": "my-firebase-project"
}