Types of Incoming Webhooks
Types of Incoming Webhooks

Types of Incoming Webhooks

Incoming webhooks provide access for external applications to send messages to regions, sites, groups, and users.
You can create two different types of incoming webhooks:
  • A webhook that specifies the intended recipient. A separate webhook is needed for each additional recipient.
  • A base webhook that enables you to specify one or more recipients when you configure the webhook on the external application. A base webhook must be specified on a region or site. The recipients must be members of the specified region or site according to the following rules:
    • If the base webhook target is a site, you can specify the groups and users of the site as recipients. You cannot specify the site.
    • If the base target is a region, you can specify child regions, sites, groups, or users of the region as recipients. You cannot specify the region.
The recipients of a base webhook are added to the URL when you configure the incoming webhook on the external application. Use standard URL query parameters to specify one or more recipients.
Examples
In this example, the URL identifies the PTT Pro group
Dept-C1othing
as a recipient:
https://[ZEMS-URL]/api/v1/service/4Gyruf16k5?group=Dept-Clothing
In this example, the URL identifies the PTT Pro group
Dept-C1othing
and the PTT Pro user
Jerry.Bloom
as recipients:
https://[ZEMS-URL]/api/v1/service/4Gyruf16k5?group=Dept-Clothing&user=Jerry.Bloom