Create Outgoing Webhook

Create an outgoing webhook for a team. The webhook sends an HTTP POST to the configured callback URLs when a message matches a trigger word or is posted in a watched channel.

Required Permissions: manage_webhooks for the team the webhook is in. manage_others_outgoing_webhooks is required if the owner of the webhook is different from the requester.

External Documentation

To learn more, visit the Mattermost documentation.

​

Parameters

Parameter	Description
Callback Urls	A comma-separated list of URLs to post the payloads to when the webhook is triggered.
Channel ID	The ID of a public channel that the webhook watches.
Content Type	The format to POST the data in.
Creator ID	The ID of the owner of the webhook if different from the requester. Required in local mode.
Description	The description for this outgoing webhook.
Display Name	The display name for this outgoing webhook.
Team ID	The ID of the team that the webhook watches.
Trigger When	Select when the webhook is triggered.
Trigger Words	A comma-separated list of words for the webhook to trigger on.

​

Example Output

{
	"id": "string",
	"create_at": -9007199254740991,
	"update_at": -9007199254740991,
	"delete_at": -9007199254740991,
	"creator_id": "string",
	"team_id": "string",
	"channel_id": "string",
	"description": "string",
	"display_name": "string",
	"trigger_words": [
		"string"
	],
	"trigger_when": 0,
	"callback_urls": [
		"string"
	],
	"content_type": "string"
}