Outgoing Webhook Endpoint

Zebra Enterprise Messaging Service Customer Administrator Guide

Use the Webhook.Outgoing to create a webhook that sends a message to an external application.

The Webhook.Outgoing includes the following methods:

Method	Description
POST /api/v1/connector/webhook	Creates an outgoing webhook that returns a whId parameter to display or delete this webhook.
GET /api/v1/connector/webhook	Returns a list of all of the outgoing webhooks.
GET /api/v1/connector/webhook/whId}	Returns the outgoing webhook specified by the whId .
DELETE /api/v1/connector/webhook/{whId}	Delete the outgoing webhook specified by the whId .

When you create an outgoing webhook, the request requires the following parameters:

Parameter	Required	Value	Description
body	Yes	Refer to the Message Body Template for the parameters of the message body.	Describes the message format.
headers	No	NA	Not required for a webhook to Microsoft Teams.
method	No	NA	Not required for a webhook to Microsoft Teams.
url	Yes	Valid URL	URL generated when creating the incoming webhook from the external application. Must include https:// .
description	No	Alphanumeric text	Enter a description of the outgoing webhook.
name	Yes	Alphanumeric text	Unique name for this webhook.
site	Yes	Alphanumeric text	Must match the region or site name.

Outgoing Webhook Example

This example adds an outgoing webhook from Site4 to an incoming Microsoft Teams webhook.

curl -X 'POST' \
 'https://<ZEMS_URL>/api/v1/connector/webhook' \
 -H 'accept: application/json' \
 -H 'ApiKey: <ZEMS_API_KEY>' \
 -H 'authorization: Bearer <TOKEN>' \
 -H 'Content-Type: application/json' \
 -d '{ "body": "{\"type\": \"message\", \"text\": \"$SENDER: $BODY\"}", \
    "description": "an example webhook", "name": "OutgoingSiteWebhook", \
    "site": "Site4", "url": "<TEAMS_INCOMING_WEBHOOK_URL" }'