# Confirm a webhook subscription

This endpoint confirms a webhook subscription.

NOTE

You can make a request to this endpoint by using the "confirmation_url" generated in the message returned by the request to the webhook_subscribe endpoint.

Method Path Operation*
GET /notifications/webhooks/{account}?{token} webhook_confirm_subscription

*

This endpoint does not require User Secret (API key) authorization.

# Request

Parameter Type In Description
account
required
string path Account UUID.
token
required
string query string Unique subscription token generated by the system.

# Response

Attribute Type Description
subscription dictionary
Subscription details.
Attribute Type Description
topic string Name of the topic about which the notification is sent. It must match the regular expression (opens new window) [0-9A-Za-z\.\-_]{8,128}.
account string Account UUID.
validity_ts timestamp Time at which the subscription expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
unsubscribe_url string URL to unsubscribe from a subscription.
refresh_url string URL to refresh a subscription.

# Notification message

Once the subscription is confirmed, notification messages will be delivered to the "callback_url".

Attribute Type Description
type string Message type. For notification messages value should be "Notification".
message string Message UUID.
twin string Twin UUID.
event dictionary
List of Entries where an Entry update triggered the notification with details of the Entry update in form of key-value pairs.
Key Value
new_value Value of the Entry after the update.
old_value Value of the Entry before the update.
changed_ts Time at which the value of the Entry was changed. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
sent_ts timestamp Time at which the message was sent. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
subscription dictionary
Details of the subscription.
Attribute Type Description
topic string Name of the topic about which the notification is to be sent.
account string Account UUID.
validity_ts timestamp Time at which the subscription expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
hash string Message hash.

# Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status Codes section.