API Reference version 2

Create webhook


Deprecated: Please use Create room webhook instead, which preserves extensions across add-on updates and requires only the view_messages scope.

Path parameters

Type Parameter Description Required?
string room_id_or_name

The id or url encoded name of the room

Valid length range: 1 - 100.


Request body

Type Property Description Required?
string name

The label for this webhook

string url

The URL to send the webhook POST to

string pattern

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

string authentication

The authentication method for this webhook

Valid values: jwt, none.

Defaults to 'none'.

string key

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

Valid length range: 1 - 40.

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.

201 application/json
Type Property Description Required?
str | int id

The unique identifier for the created entity

object links

An object with the following properties.

string self Required