Webhooks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Webhooks allow your application to receive real-time notifications from Zoho Payments when specific events occur, such as successful payments or failed refunds. Use the Webhooks API to register and manage webhook endpoints, subscribe to events, and verify incoming payloads using the signing key generated for each webhook. For a list of supported events and sample payloads, refer to the Webhook Events documentation.

Download Webhooks OpenAPI Document

End Points

POST

/webhooks/{webhook_url_id}

GET

/webhooks/{webhook_url_id}

DELETE

/webhooks/{webhook_url_id}

Attribute

webhook_url_id

string

The unique identifier of the webhook.

name

string

A descriptive name for the webhook endpoint. Maximum 50 characters.

url

string

The HTTPS URL of your server that will receive webhook event deliveries.

description

string

An optional description of what this webhook is used for.

status

string

The current status of the webhook endpoint. Possible values are active (delivering events), inactive (paused by you and no events are delivered), and disabled (set by Zoho Payments when your account is suspended). Only active webhooks are moved to disabled during suspension, while inactive webhooks are not affected. When the suspension is revoked, a disabled webhook is automatically restored to active.

signing_key

string

The HMAC-SHA256 signing key used to verify the authenticity of incoming webhook events. It is returned only when the webhook is created via the API. Store it securely and you can also view it later in the Zoho Payments web app. Learn how to verify the signature.

enabled_events

array

The list of event types this webhook is subscribed to. Refer to the Webhook Events documentation for the supported events and their payloads.

created_time

long

The timestamp (epoch seconds) when the webhook endpoint was created.

{
    "webhook_url_id": "1987000000724219",
    "name": "Payment notifications",
    "url": "https://example.com/zohopayments/webhook",
    "description": "Forwards payment and refund events to our order management system.",
    "status": "active",
    "signing_key": "52402c8bd2edb946a072d13e0599ef992ad661a54e4a472385c394185cfb0d2597b88415891c11356c83a739be74b5797bf8dfbacc7a80c00bc6a2f5bb74e2d49a841b172fc78069237cbffe38ddc15b",
    "enabled_events": [
        "payment.succeeded",
        "payment.failed",
        "refund.succeeded"
    ],
    "created_time": 1708950672
}

Create Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API registers a new webhook endpoint that will receive notifications for the events you subscribe to. The signing_key returned in the response is shown only at creation; store it securely so you can verify webhook signatures.
OAuth Scope : ZohoPay.settings.CREATE

Arguments

name

string

(Required)

A descriptive name for the webhook endpoint. Maximum 50 characters.

url

string

(Required)

The HTTPS URL of your server that will receive webhook event deliveries.

description

string

An optional description of what this webhook is used for.

enabled_events

array

(Required)

The list of event types this webhook is subscribed to. Refer to the Webhook Events documentation for the supported events and their payloads.

Query Parameters

account_id

string

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

HttpResponse<String> response = Unirest.post("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .header("content-type", "application/json")
  .body("{\"field1\":\"value1\",\"field2\":\"value2\"}")
  .asString();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://payments.zoho.in/api/v1/webhooks?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/webhooks?account_id=23137556",
  "method": "POST",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  },
  "processData": false,
  "data": "{\"field1\":\"value1\",\"field2\":\"value2\"}"
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/webhooks?account_id=23137556", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/webhooks?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

const unirest = require("unirest");

const req = unirest("POST", "https://payments.zoho.in/api/v1/webhooks");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
  "content-type": "application/json"
});

req.type("json");
req.send({
  "field1": "value1",
  "field2": "value2"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://payments.zoho.in/api/v1/webhooks',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: {field1: 'value1', field2: 'value2'},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
request["content-type"] = 'application/json'
request.body = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/webhooks?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"field1\":\"value1\",\"field2\":\"value2\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/webhooks');
$request->setMethod(HTTP_METH_POST);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$request->setBody('{"field1":"value1","field2":"value2"}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{"field1":"value1","field2":"value2"}');

$request->setRequestUrl('https://payments.zoho.in/api/v1/webhooks');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/webhooks?account_id=23137556");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/webhooks?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/webhooks?account_id=23137556"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://payments.zoho.in/api/v1/webhooks?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request POST \
  --url 'https://payments.zoho.in/api/v1/webhooks?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "name": "Payment notifications",
    "url": "https://example.com/zohopayments/webhook",
    "description": "Forwards payment and refund events to our order management system.",
    "enabled_events": [
        "payment.succeeded",
        "payment.failed",
        "refund.succeeded"
    ]
}

{
    "code": 0,
    "message": "Webhook added successfully",
    "webhook_url": {
        "webhook_url_id": "1987000000724219",
        "name": "Payment notifications",
        "url": "https://example.com/zohopayments/webhook",
        "description": "Forwards payment and refund events to our order management system.",
        "status": "active",
        "signing_key": "52402c8bd2edb946a072d13e0599ef992ad661a54e4a472385c394185cfb0d2597b88415891c11356c83a739be74b5797bf8dfbacc7a80c00bc6a2f5bb74e2d49a841b172fc78069237cbffe38ddc15b",
        "enabled_events": [
            "payment.succeeded",
            "payment.failed",
            "refund.succeeded"
        ],
        "created_time": 1708950672
    }
}

List Webhooks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API returns the list of webhook endpoints configured for your Zoho Payments account.
OAuth Scope : ZohoPay.settings.READ

Query Parameters

account_id

string

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

HttpResponse<String> response = Unirest.get("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .asString();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/webhooks?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/webhooks?account_id=23137556",
  "method": "GET",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/webhooks?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/webhooks?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

const unirest = require("unirest");

const req = unirest("GET", "https://payments.zoho.in/api/v1/webhooks");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://payments.zoho.in/api/v1/webhooks',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/webhooks?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/webhooks?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/webhooks');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://payments.zoho.in/api/v1/webhooks');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/webhooks?account_id=23137556");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/webhooks?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/webhooks?account_id=23137556"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://payments.zoho.in/api/v1/webhooks?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url 'https://payments.zoho.in/api/v1/webhooks?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "webhook_url": {
        "webhook_urls": [
            {
                "webhook_url_id": "1987000000724219",
                "name": "Payment notifications",
                "status": "active",
                "url": "https://example.com/zohopayments/webhook",
                "description": "Forwards payment and refund events to our order management system.",
                "created_time": 1708950672,
                "webhook_events": {
                    "total_events": 4,
                    "events": [
                        {
                            "entity_type": "payment_link",
                            "event_types": [
                                "payment_link.paid",
                                "payment_link.canceled"
                            ],
                            "entity_type_formatted": "Payment Link"
                        },
                        {
                            "entity_type": "refund",
                            "event_types": [
                                "refund.succeeded",
                                "refund.failed"
                            ],
                            "entity_type_formatted": "Refund"
                        }
                    ]
                }
            }
        ]
    }
}

Update Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API updates a webhook endpoint. The enabled_events list is required and replaces the webhook's current event subscriptions. You can also update the url, name, and description in the same request.

To pause or resume the webhook, include webhook_status set to inactive or active in the same request.
OAuth Scope : ZohoPay.settings.UPDATE

Arguments

name

string

A descriptive name for the webhook endpoint. Maximum 50 characters.

url

string

The HTTPS URL of your server that will receive webhook event deliveries.

description

string

An optional description of what this webhook is used for.

enabled_events

array

(Required)

The list of event types this webhook is subscribed to. Refer to the Webhook Events documentation for the supported events and their payloads.

webhook_status

string

The status to set for the webhook. Accepted values are active (resume event delivery) and inactive (pause event delivery). Optional — include it in an Update Webhook request only when you want to change the status.

Path Parameters

webhook_url_id

string

(Required)

The unique identifier of the webhook.

Query Parameters

account_id

string

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

HttpResponse<String> response = Unirest.put("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .header("content-type", "application/json")
  .body("{\"field1\":\"value1\",\"field2\":\"value2\"}")
  .asString();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  "method": "PUT",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  },
  "processData": false,
  "data": "{\"field1\":\"value1\",\"field2\":\"value2\"}"
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v1/webhooks/1987000000724219?account_id=23137556", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/webhooks/1987000000724219?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

const unirest = require("unirest");

const req = unirest("PUT", "https://payments.zoho.in/api/v1/webhooks/1987000000724219");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
  "content-type": "application/json"
});

req.type("json");
req.send({
  "field1": "value1",
  "field2": "value2"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://payments.zoho.in/api/v1/webhooks/1987000000724219',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: {field1: 'value1', field2: 'value2'},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
request["content-type"] = 'application/json'
request.body = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"field1\":\"value1\",\"field2\":\"value2\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setMethod(HTTP_METH_PUT);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$request->setBody('{"field1":"value1","field2":"value2"}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{"field1":"value1","field2":"value2"}');

$request->setRequestUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setRequestMethod('PUT');
$request->setBody($body);

$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request PUT \
  --url 'https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "name": "Payment notifications",
    "url": "https://example.com/zohopayments/webhook-v2",
    "description": "Updated payment webhook endpoint.",
    "enabled_events": [
        "payment.succeeded",
        "payment.failed",
        "refund.succeeded",
        "refund.failed"
    ],
    "webhook_status": "active"
}

{
    "code": 0,
    "message": "Webhook updated successfully",
    "webhook_url": {
        "webhook_url_id": "1987000000724219",
        "name": "Payment notifications",
        "url": "https://example.com/zohopayments/webhook",
        "description": "Forwards payment and refund events to our order management system.",
        "status": "active",
        "enabled_events": [
            "payment.succeeded",
            "payment.failed",
            "refund.succeeded"
        ],
        "created_time": 1708950672
    }
}

Retrieve Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API returns the details of a specific webhook endpoint, including its subscribed events.
OAuth Scope : ZohoPay.settings.READ

Path Parameters

webhook_url_id

string

(Required)

The unique identifier of the webhook.

Query Parameters

account_id

string

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

HttpResponse<String> response = Unirest.get("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .asString();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  "method": "GET",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/webhooks/1987000000724219?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/webhooks/1987000000724219?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

const unirest = require("unirest");

const req = unirest("GET", "https://payments.zoho.in/api/v1/webhooks/1987000000724219");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://payments.zoho.in/api/v1/webhooks/1987000000724219',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url 'https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "webhook_url": {
        "webhook_url_id": "1987000000724219",
        "name": "Payment notifications",
        "url": "https://example.com/zohopayments/webhook",
        "description": "Forwards payment and refund events to our order management system.",
        "status": "active",
        "enabled_events": [
            "payment.succeeded",
            "payment.failed",
            "refund.succeeded"
        ],
        "created_time": 1708950672
    }
}

Delete Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API permanently deletes a webhook endpoint. Deleted endpoints stop receiving event notifications and cannot be restored. To temporarily disable event delivery, set the webhook status to inactive using the Update Webhook API.
OAuth Scope : ZohoPay.settings.DELETE

Path Parameters

webhook_url_id

string

(Required)

The unique identifier of the webhook.

Query Parameters

account_id

string

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

HttpResponse<String> response = Unirest.delete("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .asString();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  "method": "DELETE",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/api/v1/webhooks/1987000000724219?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/webhooks/1987000000724219?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

const unirest = require("unirest");

const req = unirest("DELETE", "https://payments.zoho.in/api/v1/webhooks/1987000000724219");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://payments.zoho.in/api/v1/webhooks/1987000000724219',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setMethod(HTTP_METH_DELETE);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://payments.zoho.in/api/v1/webhooks/1987000000724219');
$request->setRequestMethod('DELETE');
$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request DELETE \
  --url 'https://payments.zoho.in/api/v1/webhooks/1987000000724219?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "WebhookURL deleted successfully"
}

Webhooks AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Attribute

Create Webhook AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

List Webhooks AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update Webhook AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Query Parameters

Retrieve Webhook AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Delete Webhook AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Webhooks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List Webhooks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete Webhook AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab