Overview

Namespaces

  • LoginRadiusSDK
    • Advance
    • Clients
    • CustomerRegistration
      • Account
      • Authentication
      • Social
    • Utility

Classes

  • ConfigAPI
  • WebHooksAPI
  • Overview
  • Namespace
  • Class

Class WebHooksAPI

Class WebHooksAPI

This is the main class to communicate with Webhook APIs.

Namespace: LoginRadiusSDK\Advance
Located at LoginRadiusSDK/Advance/WebHooksAPI.php
Methods summary
public
# __construct( type $apikey = '', type $apisecret = '', type $options = array() )

Parameters

$apikey
$apisecret
$options
public type
# webHooksSettings( )

Test WebHooks settings on your LoginRadius site.

Test WebHooks settings on your LoginRadius site.

Returns

type
public type
# subscribeWebHooks( $target_url, $event = 'Login' )

This API allow you to subscribe WebHook on your LoginRadius site.

This API allow you to subscribe WebHook on your LoginRadius site.

Parameters

$target_url
where trigger will send data when it invoke
$event
of event, Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, CreateTraditionalAccount, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber

Returns

type
public type
# getWebHooksSubscribedUrls( string $event = 'Login' )

This API retrieves all of the Urls subscribed to a given WebHook event

This API retrieves all of the Urls subscribed to a given WebHook event

Parameters

$event

Returns

type
public type
# unsubscribeWebHooks( $target_url, $event = 'Login' )

This API allow you to unsubscribe WebHook on your LoginRadius site.

This API allow you to unsubscribe WebHook on your LoginRadius site.

Parameters

$target_url
where trigger will send data when it invoke
$event

Returns

type
API documentation generated by ApiGen