Outgoing Webhook APIs- An Overview

Overview

Outgoing webhooks allow Zoho CommunitySpaces to send event information to an external application when a specified event occurs.

Using the outgoing webhooks APIs, you can programmatically create, retrieve, update, and delete outgoing webhooks in your Zoho CommunitySpaces community.

When creating a webhook, you specify the endpoint URL and the events that should trigger the webhook. When one of these events occurs, Zoho CommunitySpaces sends the relevant event information to the configured endpoint.

Webhook attributes

The following attributes are used when creating, retrieving, or updating an outgoing webhook.

Name	Data Type	Description	Pre-requisite
id	Long	Unique Id of the webhook	Read only
name	String(50)	Name of the webhook	Mandatory
description	String (250)	Description of the webhook	Optional
url	String (500)	Server endpoint to which event information must be sent	Mandatory
active	Boolean Default value : true	Key that returns if the webhook is enabled or not.	Optional
createdBy	Long	ID of user who created the webhook	Read only
createdTime	Long	Time of webhook creation.	Read only
autoRetry	Boolean default value : false	Key that returns if the auto retry option is enabled or not	Optional
triggers	JSONArray	Array of triggers for which the webhook action should be performed	Mandatory

Attributes of the webhook trigger

The following attributes are present in a webhook trigger payload.

Name

Data Type

Description

Pre -requisite

type

String

Unique key of the Webhook Trigger

Mandatory

partitionIds

JSONArray of partitionIds

The ID of the Connect entities in which the trigger action has been done.

Optional

For example, the type determines the event that triggers the webhook, while partitionIds can be used to limit the trigger to specific entities.

Webhook APIs

Use the following APIs to manage outgoing webhooks in Zoho CommunitySpaces:

Get webhook- Retrieves the details of a specific outgoing webhook from your Zoho CommunitySpaces community.

Learn how to get a webhook

Create webhook- Creates an outgoing webhook in your Zoho CommunitySpaces community.

Learn how to create a webhook

Update webhook- Updates the details of an existing outgoing webhook, such as its name, description, triggers, and URL.

Learn how to update a webhook

Delete webhook- Deletes an existing outgoing webhook from your Zoho CommunitySpaces community.

Learn how to delete a webhook