Incoming Webhook Endpoint
Incoming Webhook Endpoint

Incoming Webhook Endpoint

Use the Webhook.Incoming endpoint to manage webhooks intended for ZEMS users, groups, sites, or regions.
The Webhooks.Incoming endpoint includes the following methods:
Method
Description
POST /api/v1/connector/app
Creates an incoming webhook and returns the
appId
and URL parameters. The
appId
is used by this endpoint to display or delete the webhook. The URL parameter is required for the outgoing webhook on the external application.
When
base
is true, the target must be a region or site.
GET /api/v1/connector/app
Returns all incoming webhooks.
GET /api/v1/connector/app/{appId}
Returns the incoming webhook specified by the
appId
.
DELETE /app/v1/connector/app/{appId}
Removes the incoming webhook specified by the
appId
.
When you create an incoming webhook, the method requires that the target is identified.
Target
Value
Description
User
0
User name as specified in the PTT Pro server.
Group
1
Group name as specified in the PTT Pro server.
Site
2
Department name as specified in the PTT Pro server.
Region
3
Region name as defined in ZEMS.