Webhook APIs

Use the Webhooks APIs to receive event notifications or subscribe to events happening in a sub-merchant's account for the integration installed.

Know more about

Webhook Events

and check the

sample payloads

for Sub-Merchant Onboarding Events.

Explore the Webhook API collection in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

List of Endpoints

API Endpoint	Description
Create a Webhook	Creates a webhook.
Fetch a Webhook With id	Retrieves the details of a webhook.
Fetch all Webhooks	Retrieves the details of all webhooks.
Update a Webhook	Updates a webhook.
Delete a Webhook	Deletes a webhook.

Webhook Entity

The Webhook entity consists of the following fields.

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.