API Reference version 2

Create global webhook

PUT/v2/extension/webhook/{key}

Create a global webhook.

Dynamically created webhooks have the following restrictions:

  • You can only create 10 global webhooks
  • You cannot modify a webhook that was declared in the descriptor
Authentication required, with scope view_messages.
Accessible by group clients.

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

Request body

Type Property Description Required?
string name

The label for this webhook
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 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.

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

The unique identifier for the created entity

 Required
object links

An object with the following properties.

 Required
string self Required