Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Partners

Webhooks

Update

API Test Keys

Update a Webhook

PATCH
/v2/accounts/:account_id/webhooks/:webhook_id

Click to copy

Use this endpoint to update the details of a webhook. Know about the

various error responses

for this API.

Is this page helpful?

Curl

change language

change language

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-H "Content-Type: application/json" \
3
-X PATCH https://api.razorpay.com/v2/accounts/acc_H3kYHQ635sBwXG/webhooks/HK890egfiItP3H \
4
-d '{
5
  "url": "https://www.linkedin.com",
6
  "events": [
7
    "refund.created"
8
  ]
9
}'

Success

1
{
2
  "id": "HK890egfiItP3H",
3
  "created_at": 1623060358,
4
  "updated_at": 1623067148,
5
  "service": "beta-api-test",
6
  "owner_id": "H3kYHQ635sBwXG",
7
  "owner_type": "merchant",
8
  "context": [],
9
  "disabled_at": 0,
10
  "url": "https://www.linkedin.com",
11
  "alert_email": "gaurav.kumar@example.com",
12
  "secret_exists": true,
13
  "entity": "webhook",
14
  "active": true,
15
  "events": [
16
    "refund.created"
17
  ]
18
}
Path Parameters
account_id

*

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_H3kYHQ635sBwXG

webhook_id

*

string

The unique identifier of the webhook whose details are to be updated. For example, HK890egfiItP3H

Request Parameters
url

*

string

The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.

events

*

object

The required events from the list of Active Events. For example, payment.authorized, payment.captured, payment.failed, payment.dispute.created, refund.failed, refund.created and so on.

Response Parameters
id
string

The unique identifier of the created webhook. For example, HK890egfiItP3H. This id is used to fetch, update or delete a webhook. The maximum length is 14 characters.

created_at
integer

The Unix timestamp at which the webhook has been created.

updated_at
integer

The Unix timestamp at which the webhook has been updated.

owner_id
string

The unique identifier generated by Razorpay for the sub-merchant who will receive the webhooks. For example, in this case, it will be account_id passed in the API URL.

owner_type
string

Indicates the type of owner. For example, in this case, it will be the merchant.

url
string

The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.

secret
string

A secret for the webhook endpoint used to validate that the webhook is from Razorpay.

alert_email
string

This is the email address to which notifications must be sent in case of webhook failure.

secret_exists
boolean

This attribute is set to true if a secret password has been set for the webhook endpoint. If no secret is sent in the request, this parameter does not appear in the response code.

entity
string

Indicates the type of entity. For example, in this case, it will be webhook.

active
string

Indicates the status of webhook.

  • true: Webhook is activated.
  • false: Webhook is deactivated.

events
object

The required events from the list of Active Events. For example, payment.authorized, payment.captured, payment.failed, payment.dispute.created, refund.failed, refund.created and so on.

Update a Webhook

PATCH
/v2/accounts/:account_id/webhooks/:webhook_id

Click to copy

Use this endpoint to update the details of a webhook. Know about the

various error responses

for this API.

Is this page helpful?

Path Parameters
account_id

*

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_H3kYHQ635sBwXG

webhook_id

*

string

The unique identifier of the webhook whose details are to be updated. For example, HK890egfiItP3H

Request Parameters
url

*

string

The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.

events

*

object

The required events from the list of Active Events. For example, payment.authorized, payment.captured, payment.failed, payment.dispute.created, refund.failed, refund.created and so on.

Response Parameters
id
string

The unique identifier of the created webhook. For example, HK890egfiItP3H. This id is used to fetch, update or delete a webhook. The maximum length is 14 characters.

created_at
integer

The Unix timestamp at which the webhook has been created.

updated_at
integer

The Unix timestamp at which the webhook has been updated.

owner_id
string

The unique identifier generated by Razorpay for the sub-merchant who will receive the webhooks. For example, in this case, it will be account_id passed in the API URL.

owner_type
string

Indicates the type of owner. For example, in this case, it will be the merchant.

url
string

The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.

secret
string

A secret for the webhook endpoint used to validate that the webhook is from Razorpay.

alert_email
string

This is the email address to which notifications must be sent in case of webhook failure.

secret_exists
boolean

This attribute is set to true if a secret password has been set for the webhook endpoint. If no secret is sent in the request, this parameter does not appear in the response code.

entity
string

Indicates the type of entity. For example, in this case, it will be webhook.

active
string

Indicates the status of webhook.

  • true: Webhook is activated.
  • false: Webhook is deactivated.

events
object

The required events from the list of Active Events. For example, payment.authorized, payment.captured, payment.failed, payment.dispute.created, refund.failed, refund.created and so on.

Curl

change language

change language

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-H "Content-Type: application/json" \
3
-X PATCH https://api.razorpay.com/v2/accounts/acc_H3kYHQ635sBwXG/webhooks/HK890egfiItP3H \
4
-d '{
5
  "url": "https://www.linkedin.com",
6
  "events": [
7
    "refund.created"
8
  ]
9
}'

Success

1
{
2
  "id": "HK890egfiItP3H",
3
  "created_at": 1623060358,
4
  "updated_at": 1623067148,
5
  "service": "beta-api-test",
6
  "owner_id": "H3kYHQ635sBwXG",
7
  "owner_type": "merchant",
8
  "context": [],
9
  "disabled_at": 0,
10
  "url": "https://www.linkedin.com",
11
  "alert_email": "gaurav.kumar@example.com",
12
  "secret_exists": true,
13
  "entity": "webhook",
14
  "active": true,
15
  "events": [
16
    "refund.created"
17
  ]
18
}