Example Ping Request
$ curl -XPOST \
https://api.intercom.io/subscriptions/nsub_6ab4c480-fd8b-11e3-958f-c779cae3e1b3/ping \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
HTTP/1.1 200 Ok
Example Ping Notification
{
"type": "notification_event",
"topic": "ping",
"id": "notif_ccd8a4d0-f965-11e3-a367-c779cae3e1b4",
"created_at": 1392731331,
"delivery_attempts": 1,
"first_sent_at": 1392731392,
"data": {
"item": {
"type": "ping",
"message": "shipping is your company's heartbeat"
}
}
}
Each Subscription object can be pinged by sending a POST
notification to -
https://api.intercom.io/subscriptions/{id}/ping
Where {id}
is the id of the subscription. This results in a ping notification being sent to the url of the webhook. For services a message is rendered and presented.
The Ping object has the following fields -
Attribute | Type | Description |
---|---|---|
type | string | value is 'ping' |
message | string | A text message |
Note that all subscriptions should be implemented to accept ping events, as the API may send them at any time.