v1

latestOpenAPI 3.0.02026-07-1412360190.8 KB

Outgoing Webhooks

Registers a WebHook

Registers the webHook with the given filter and callback URL. OauthScopes: READ_CONVERSATIONS, READ_USER

post/webhooks

Response

The webHook was successfully registered

creationTimenumber

The time when this WebHook was created. This does not necessary mean the time when an manifest file was created.

filterstring[]

An optional list of filter parameters for this webhook.

idstring

The unique identifier for this webhook. Can be used later to unregister the webhook.

subscriptionIdsstring[]

The optional list of userids for which this webhook is subscribed, i.e. presence events for the user are forwarded to the WebHook callback URL.

typestring

The type of a WebHook. This can either be MANUAL or EXTENSION. While manual WebHooks are only temporary and for development only use, permanent ones (EXTENSION) will bemanaged by the system.

urlstring

The callback URL of this webhook.

userIdstring

The user ID for which this webhook is subscribed, i.e. events for this user are forwarded to the WebHook callback URL.