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

-
The publisher app connects to a topic in the Pub/Sub service. It then sends messages to this topic.
-
Messages are retained in message storage.
-
Messages are forwarded from the topic to all associated subscriptions individually.
-
The messages are transmitted by pushing to an endpoint or pulling from the service itself.
-
The subscriber application informs the Pub/Sub service that messages are received.
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.
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.
Prerequisites
-
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.
Instructions
-
Log in to your ReachFive Console.
-
Go to
. -
Select New Pub/Sub hook or edit
an existing Pub/Sub Hook.
-
Enable your Pub/Sub hook.
-
Give your hook a Key. This is a unique reference for the hook.
-
From the drop-down menu, choose the Event types that will trigger the Pub/Sub hook.
-
Optionally, add Filters to your hook.
Adding filters means only those fields matching the filter criteria are returned from the Pub/Sub hook. -
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.
:email
→user.email
. -
Enter your Project ID for your Google Cloud account.
-
Enter the Topic where you want requests sent.
-
Enter the Credentials (in
JSON
format) needed to connect to Google Cloud. -
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.
-
Go to Topics.
-
Choose the desired Topic ID.
-
Click View Messages.
-
Select the desired Cloud Pub/Sub subscription.
-
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. |
||
|
Emitted after a one-time password (otp) is successfully sent (via sms or email) for verification.
|
||
|
Emitted after an unsuccessful login attempt due to the password not matching. |
||
|
Emitted after a successful login via the |
||
|
Emitted after a successful user update. |
||
|
Emitted after a successful user deletion.
|
||
|
Emitted after a successful merge (for the updated user). |
||
|
Emitted after a successful merge (for the deleted user). |
||
|
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. |
||
ACCOUNT PROTECTION |
|||
|
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 when a user profile is created with a suspicious IP. |
||
|
Emitted when a risky login notification was sent to the user. |
||
|
Emitted when the risk_score threshold was exceeded. |
||
WEBHOOK FAILURES |
|||
|
Emitted when a failure occurred in the pre-event webhook.
|
||
|
Emitted when a failure occurred in the post-event webhook.
|
||
RETRY FAILURE EVENTS |
|||
|
Emitted if there is an error while sending an |
||
|
Emitted if there is an error while sending an |
||
USER LOCKOUT EVENTS |
|||
|
Emitted each time a user profile is locked. |
||
MFA EVENTS |
|||
|
Emitted after an MFA credential (phone number) is deleted. |
||
|
Emitted after an MFA credential (email) is deleted. |
||
|
Emitted after an email is used to start the MFA registration process. |
||
|
Emitted after an email has been verified as an MFA credential. |
||
|
Emitted after a phone number is used to start the MFA registration process. |
||
|
Emitted after a phone number has been verified as an MFA credential. |
||
|
Emitted after a device has been added as a trusted device . |
||
|
Emitted after a device has been removed as a trusted device . |
||
CONSENT EVENTS |
|||
|
Emitted after a consent was successfully granted. |
||
|
Emitted after a DOI consent was moved to the |
||
|
Emitted after a consent was officially rejected (denied). |
||
GUEST EVENTS |
|||
|
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
- Topic
-
A named resource to which messages are sent by publishers.
- Subscription
-
A named resource representing the stream of messages from a single, specific topic, to be delivered to the subscribing application.
- Message
-
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.
Resource: Google Cloud Pub/Sub Core Concepts