Please Wait

Loading..

Webhook

Notify Presence and Publish events to external Rest Server using Webhooks

Configure Webhook with Yalgaar

Presence

Get Updates of Channels Subscribe or Unsubscribe via HTTP POST request.
Each Presence Webhook request contains following body.

{"items":
	{"source":"Presence",
	 "clientKey":"",
	 "data":[{
			"channel":"",
			"uuid":"",
			"timestamp":"",
			"action":""
		}]
	}
}

Parameter:

  • sources
    • Description: Define the source name as "Presence".
    • DataType: String
  • clientKey
    • Description: Yalgaar provided authentic client key for project.
    • DataType: String
  • data
    • Description: Defines the list of object.
    • DataType: List
  • channel
    • Description: Name of the channel which is subscribe or unsubscribe by the user.
    • DataType: String
  • uuid
    • Description: Unique user name.
    • DataType: String
  • timestamp
    • Description: Time in seconds when channel bind or unbind.
    • DataType: String
  • action
    • Description: Action represent channel bind or unbind.
    • DataType: String

Message

Get information of published messages on channels via HTTP POST request.
Each Message Webhook request contains following body.

{"items":
	    {"source":"Message",
	     "clientKey":"",
	     "data":[{
			    "channel":"",
			    "uuid":"",
			    "timestamp":"",
			    "message":""
		    }]
	    }
    }

Parameter:

  • sources
    • Description: Define the source name as "Message.
    • DataType: String
  • clientKey
    • Description: Yalgaar provided authentic client key for project.
    • DataType:string
  • data
    • Description: Defines the list of object.
    • DataType: list
  • channel
    • Description: Name of the channel which is subscribe or unsubscribe by the user.
    • DataType: String
  • uuid
    • Description: Unique user name.
    • DataType: String
  • timestamp
    • Description: Time in seconds when channel bind or unbind.
    • DataType: String
  • message
    • Description: Data which is publish by user.
    • DataType: String

Configuring WebHook with following steps

  1. First login to your dashboard. Select you app and enable Webhook.

    Javascript Security
  2. Add Presence and Message URL and Save Changes.

    Javascript Security

Try another tutorials