Skip to main content

Push Server

The Push Server sends WalletConnect protocol activity using FCM or APNs to users. The Push Server can be used with our Notify API and Web3Wallet SDK.

Several options exist for setting up the Push Server:

  1. Using WalletConnect Cloud (recommended)
  2. Self-host the Push Server
  3. Write your own implementation using the spec

It is recommended that you use WalletConnect Cloud for simplicity and ease of integration. Typically you only need to self-host if you have concerns about our hosted platform having access to your FCM or APNs server credentials, such as for regulatory reasons. If you want to self-host or implement against the spec, please reach out to devrel@walletconnect.com for assistance.

Setup in WalletConnect Cloud

  1. Create a Project in the Cloud App. Go to WalletConnect Cloud and sign up for an account.

  2. To get your project's Push URL, from the Cloud App, go into the settings tab and click on Create Push URL.

create-push-url

  1. From the same settings tab, you will see the FCM and the APNS settings becomes available to setup. Add your FCM and/or APNs details.

fmc-and-apns-details-form

Firebase Cloud Messaging (FCM)

Google's FCM allows you to use send notifications to both Android and Apple devices. At this time, we only support Android devices via FCM.

Currently we only support Cloud Messaging API (Legacy) but are currently working on supporting Firebase Cloud Messaging API (V1) very soon.

Apple Push Notifications (APNs)

Apple recommends using a Token-Based Connection for APNS over a Certificate-Based connection. Please refer to their documentation for instructions on obtaining either.