Skip to main content
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 DocumentationTo learn more, visit the Mattermost documentation.

Parameters

ParameterDescription
Callback UrlsA comma-separated list of URLs to post the payloads to when the webhook is triggered.
Channel IDThe ID of a public channel that the webhook watches.
Content TypeThe format to POST the data in.
Creator IDThe ID of the owner of the webhook if different from the requester. Required in local mode.
DescriptionThe description for this outgoing webhook.
Display NameThe display name for this outgoing webhook.
Team IDThe ID of the team that the webhook watches.
Trigger WhenSelect when the webhook is triggered.
Trigger WordsA 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"
}

Workflow Library Example

Create Outgoing Webhook with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop