Get Webhook Details

Use this API to get webhook details such as webhook name, type, actions and authorization details if included.

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/settings/webhook/{webhook_id}

Content-Type

application/json

List of Response Body Attributes

Parameters	Data Type	Description
webhook	JSON Object	Contains all the details pertaining to the webhook.
created_time	String	Time at which webhook was created (in milliseconds).
is_active	Boolean	Returns a true or false value indicating if the webhook is active or not.
webhook_actions	JSON Array	The action for which a webhook is called in your application.
type	String	Depicts the request type of the API. Example: POST, PUT, etc.
created_by	String	Name of the user from whose account webhook was created using API.
url	String	The URL to which information about emails should be sent.
authorization	JSON Object	If provided, it will be used to make the call to your application, so that you can verify whether it is coming from the right sender. ➤ auth_type - 'Username' or 'Auth Token' ➤ auth_password - Required if auth_type is 'Username' ➤ auth_username - Required if auth_type is 'Username' ➤ auth_token - Required if auth type is 'Auth Token'
webhook_id	String	Unique ID of a webhook that can be used in APIs.
name	String	Name of the webhook.
custom_data	JSON Object	Additional information to be sent to your application as request data.
custom_headers	JSON Object	Additional information to be sent to your application as request headers.
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.

Run in Postman View Collection

Sample Response - Success

Copied{
    "webhook": {
        "is_virtual": false,
        "created_time": "1675947040032",
        "is_active": true,
        "webhook_actions": [
            "bounce"
        ],
        "type": "POST",
        "created_by": "Zylker",
        "version": 2,
        "url": "https://zylker.com/bounceone",
        "authorization": {
            "auth_type": "Username",
            "auth_username": "zylker",
            "auth_password": "zylker",
            "auth_token": ""
        },
        "webhook_id": "5000000322042",
        "name": "Bounce new webhook",
        "field_list": {
            "5000000000029": "contact_email"
        },
        "custom_data": {
            "data": {
                "module": "workflow",
                "region": "EU"
            },
            "status": true
        },
        "custom_headers": {
            "headers": {
                "Webhook-Type": "Bounce"
            },
            "status": true
        }
    },
    "response": {
        "code": 200202,
        "message": "Successfully obtained the webhook details"
    }
}