Webhooks

If you do not want to use the push service of a third party you can set-up a webhook where we will send all the push notifications to. You can use any endpoint you want to receive the notification of, you just need to make sure our servers can access it.

To set this up you will need to share 1 or 2 options with us. The actual endpoint and optionally a static header that we will send with every request. If you need a dynamic authorization header, we currently only support OAuth for that and you will need to send us the information described in OAuth webhooks.

Option	Required	Description	Example
endpoint	yes	The URL of the endpoint that we will send all push notifications to.	https://yourendpoint/foo/bar
header(s)	no	A JSON value that contains static headers that we will add every time we send something to the endpoint. This can be used if you need us to send a static authorization so that we can reach the endpoint. This is optional because we will sign any notification that we send which is the method you can use to identify real notifications from us.	{"Authorization":"Bearer 31217c9ed3fe820104cf3dbf0cf71b9aa3059a4b"}

Send these settings to us via support@parley.nu. If you send us a static authorization header make sure to encrypt it or send a part of it through a second means of communication (a parley conversation, SMS, etc.). We will then setup your Parley account So that you can receive notifications on the webhook.

Make sure that the when you register a device you will set the push type to webhook so that we will use that configuration to send the notification to for those devices.

The notifications you will receive

When the webhook is set-up correctly you will start to receive different types of notifications. I will briefly explain the differences and the fields you are receiving.

New message notification

This notification will be triggered on each new message that is send from the Service

Property name	Data type	Description
data	Object	The contents of the notification
data.type	String	This is an enum * message An indicator of the type of notification you receive. The current enum can expand, make sure your code will ignore types it doesn't recognize.
data.object	Object	An object containing the message or event (depending on the type).
data.object.id	Integer	The id of the message in Parley.
data.object.time	Integer	The time when the message was send to Parley.
data.object.message	String	Could contain one of these things: * The plain-text message the user send to Parley * A pre-set message which you can configure in the admin.parley.nu environment under Settings -> Push notifications -> generic push message * A photo camera icon (📷) which is set only when the message contains an image.
data.object.image	String	null
data.object.typeId	Integer	This is an enum * 2 Message * 3 Info message * 5 System message The type of this message.
data.object.agent	Object	null
data.object.agent.id	Integer	The id of this Agent in Parley.
data.object.agent.name	String	The name of this Agent in Parley
data.object.agent.avatar	String	A url to the avatar for this Agent.
to	String[]	This will be an array of one or more push tokens that you have register in the POST devices call of the client API. These indicate the different receivers of this notification. For now we only send 1 message per device and this array will always contain 1 push token. In the future we will think about grouping multiple tokens into this array.

{
  "data": {
    "type": "message",
    "object": {
      "id": 3651,
      "time": 1581687386,
      "message": "Hi there",
      "image": null,
      "typeId": 2,
      "agent": {
        "id": 1,
        "name": "Tracebuzz",
        "avatar": "https://beta.tracebuzz.com/V002/img/avatar.php?i=TB&c=f4931d"
      }
    }
  },
  "to": [
    "0801fc577294c34e0b28ad2839435945"
  ]
}

New event notification

This notification will be triggered on each new event that is send from the Service

Property name	Data type	Description
data	Object	The contents of the notification
data.type	String	This is an enum * event An indicator of the type of notification you receive. The current enum can expand, make sure your code will ignore types it doesn't recognize.
data.object	Object	An object containing the message or event (depending on the type).
data.object.name	String	The name of the event that is triggered
data.object.body	Object	Object containing the information for this specific event. Different events can have different bodies. Currently we only have the startTyping and stopTyping events. (which use the same body)
data.object.body.agent	Object	null
data.object.body.agent.id	Integer	The id of this Agent in Parley.
data.object.body.agent.uid	String	The unique identifier for this Agent in Parley
data.object.body.agent.name	String	The name of this Agent in Parley
data.object.body.agent.avatar	String	A url to the avatar for this Agent.
to	String[]	This will be an array of one or more push tokens that you have register in the POST devices call of the client API. These indicate the different receivers of this notification.

{
  "data": {
    "type": "event",
    "object": {
      "name": "startTyping",
      "body": {
        "agent": {
          "id": 1,
          "uid": "-1",
          "name": "Tracebuzz",
          "avatar": "https://beta.tracebuzz.com/V002/img/avatar.php?i=TB&c=f4931d"
        }
      }
    }
  },
  "to": [
    "0801fc577294c34e0b28ad2839435945"
  ]
}