API Reference version 2

Get room webhook

GET/v2/room/{room_id_or_name}/extension/webhook/{key}

Retrieve a webhook.

Path parameters

Type Parameter Description Required?
string key

Unique key (in the context of the integration) to identify this webhook.

Valid length range: 1 - 40.

Required
string room_id_or_name

The id of the room

Valid length range: 1 - 100.

Required
200 application/json
Type Property Description Required?
string name

The label for this webhook

string created

Time the webhook was created in ISO 8601 format UTC.

Required
string url

The URL to send the webhook POST to

Required
string pattern

The regular expression pattern to match against messages. Only applicable for message events.

string event

The event to listen for

Valid values: room_archived, room_created, room_deleted, room_enter, room_exit, room_file_upload, room_message, room_notification, room_topic_change, room_unarchived.

Required
string authentication

The authentication method for this webhook

Valid values: jwt, none.

Defaults to 'none'.

string key

The unique key of the webhook in the context of the integration

integer id

The webhook ID

Required
object room

The room, if specified, that this webhook is restricted to. Will be null for global extensions

May be null.

Required
string name

Name of the room.

Required
object links

URLs to retrieve room information

Required
string self

The URL to use to retrieve the full room information

Required
string webhooks

The URL to use to retrieve webhooks registered for this room

Required
string members

The URL to use to retrieve members for this room. Only available for private rooms. Note this link will be made available to public room from Dec 1, 2016

string participants

The URL to use to retrieve participants for this room

Required
string privacy

Privacy setting

Valid values: public, private.

Required
boolean is_archived

Whether or not this room is archived.

Required
string version

An etag-like random version string.

Required
integer id

ID of the room.

Required