Skip to main content

How it works

Once you have integrated your button, the session create will have a number of task to peform

Login​

When the user logs in, the authentication process, behind the scenes, contacts the Subscripto server to check the user subscription status.

We recommend you implement a service to check the valid status of a user. For example, the user may have run out of credit to continue usage, the user may have been blocked by subscripto, so you may need to take actions to auto log out the user and deny furthe usage.

During usage (PAYG)​

Whilst the user is subscribed as a PAYG user, Subscripto will occassionally sumbit callback event that will require a response from your application. This is similar to a hearbeat. Its purpose is to ensure that the users session is still active and that changes for usage should continue.

Subscripto callback​

We recommend, as an application owner, you create an webhook endpoint for receiving events from Subscripto. This is the recommended way to receive events and ongoing updates. When creating an application you can enter the callback URL endpoint.

Subscripto Partner API​

As a partner, you have access to the Partner API. This allows you to perform certain programmatical actions from within your application in addition or alternatively to receiving and processing callback events. You can find the Partner API here

Flow​

Application join/leave​

When the user signs up to your application or disconnects, you will receive events

  • Event: NEW_JOINER
  • Event: NEW_LEAVER

Login flow​

When a user click on "Login with Subscripto" button, once veriified, we will send an event confirming the start of the session. This will be alongside the response from the redirection.s

  • Event: USER_SESSION_START

Logout flow​

When the user logs out of your application, you will receivea

  • Event: USER_SESSION_END