Pub/Sub hooks

You can create and use Pub/Sub hooks with ReachFive. This page introduces Pub/Sub hooks and instructs you on how to create one using the ReachFive Console.

Pub/Sub is an asynchronous messaging service that offers real-time message delivery along with reliable memory storage of the messages. Pub/Sub also decouples event production from event processing.

We will briefly look at the publisher-subscriber (Pub/Sub) relationship below.

If you don’t immmediately recognise the terms here, check out the important terms below.
pub sub
  1. The publisher app connects to a topic in the Pub/Sub service. It then sends messages to this topic.

  2. Messages are retained in message storage.

  3. Messages are forwarded from the topic to all associated subscriptions individually.

  4. The messages are transmitted by pushing to an endpoint or pulling from the service itself.

  5. The subscriber application informs the Pub/Sub service that messages are received.

Why use Pub/Sub?

A major advantage of using Pub/Sub (as opposed to webhooks) is message storage (step 2 above) as well as subscriber acknowledgement of receiving the message (step 5 above). Until all subscriber applications have acknowledged receiving the message, Pub/Sub continues distributing the message to all relevant subscribers. This greatly improves guaranteed message delivery.

I just want to see a video

Skip ahead to a short video tutorial on how to configure a Pub/Sub hook from the ReachFive Console.

Create Pub/Sub hook from console

The Pub/Sub hook that you create in the ReachFive Console is triggered after an event is generated similar to that of a typical Post-event webhook.


  • You must have access to the ReachFive Console.

  • You must have a Developer, Manager, or Administrator role.

  • You must have the Pub/Sub Hooks feature enabled.


  1. Log in to your ReachFive Console.

  2. Go to Settings  Pub/Sub Hooks  User Events.

  3. Select New Pub/Sub hook or edit edit icon an existing Pub/Sub Hook.

  4. Enable your Pub/Sub hook.

  5. Give your hook a Key. This is a unique reference for the hook.

  6. From the drop-down menu, choose the Event types that will trigger the Pub/Sub hook.

  7. Optionally, add Filters to your hook.

    Adding filters means only those fields matching the filter criteria are returned from the Pub/Sub hook.

    Filterable fields

    • user email

    • user email verified

    • user verified emails

    • user unverified emails

    • user phone number

    • user phone number verified

    • user username

    • user first name

    • user last name

    • user name

    • user nickname

    • user gender

    • user age

    • user external id

    • user authentication types

    • user providers

    • user devices

    • user city

    • user country

    • user nb of logins

    • user nb of friends

    • user nb of local friends

    • user first login

    • user last login

    • user last login type

    • user created at

    • user updated at

    • user lite only

    • user suspension status

    • user title

    • user locality

    • user region

    • user country

    • user recipient

    • user company

  8. Choose the event fields and/or user fields you want to send in the request to your application. This is a comma-separated list.

    User fields should be prefixed with user.:
  9. Enter your Project ID for your Google Cloud account.

  10. Enter the Topic where you want requests sent.

  11. Enter the Credentials (in JSON format) needed to connect to Google Cloud.

  12. Don’t forget to Save your input.

View Pub/Sub results

To view the User Events, you should go to your Pub/Sub page in your Google Cloud Platform (GCP) account.

  1. Go to Topics.

  2. Choose the desired Topic ID.

  3. Click View Messages.

  4. Select the desired Cloud Pub/Sub subscription.

  5. Follow the on-screen instructions.

User Event Types

The table below describes the types of events that occur under the type parameter in the User Event object.

Name Description


Emitted after a successful authentication.


Emitted after a successful signup.


Emitted after a new user is successfully created through the Management API.


Emitted after a successful unlink identity.


Emitted after a successful email update.


Emitted after a successful phone number update.


Emitted after a successful phone number verification.


Emitted after a successful password reset request.


Emitted after a successful password change.


Emitted after a successful password reset process.


Emitted when the IFP module detects a compromised profile.

The event is only available to extract with a webhook or Pub/Sub hook if the compromised-profile feature is enabled on your ReachFive Console.


Emitted after a one-time password (otp) is successfully sent (via sms or email) for verification.

This includes otps for Two-factor authentication (2FA) flows.


Emitted after an unsuccessful login attempt due to the password not matching.


Emitted after a successful user update.


Emitted after a successful user deletion.

We retain the user_deleted event type for a certain period of time after a user profile is deleted.


Emitted after a successful merge (for the updated user).


Emitted after a successful merge (for the deleted user).


Emitted after a successful user account suspension.


Emitted after a successful user account unsuspension.


Emitted after an unsuccessful login attempt on a suspended account with the correct credentials.


Emitted after a successful email verification.


Emitted after a successful mobile number verification.


Emitted after successfully creating a new Lite profile.


Emitted after an unsuccessful authorization attempt.


Emitted after authorization was deleted.


Emitted after authorization was successfully granted.


Emitted after a lite profile was succesfully merged into a managed profile.


Emitted after the user has successfully logged in using the Two-factor authentication (2FA) flow.



Emitted after an unsuccessful login due to the identifier format.


Emitted after an unsuccessful login attempt due to an unknown identifier.


Emitted after an unsuccessful signup attempt due to an invalid email format.


Emitted after an unsuccessful signup attempt because the password was not compliant.

Important terms


A named resource to which messages are sent by publishers.


A named resource representing the stream of messages from a single, specific topic, to be delivered to the subscribing application.


The combination of data and (optional) attributes that a publisher sends to a topic and is eventually delivered to subscribers.

Message attribute

A key-value pair that a publisher can define for a message.

Video tutorial