List Webhook API

This API is used to fetch the list of webhook configurations that you have created. It allows you to retrieve all the webhook details including the webhook ID, target URL, associated events, authentication credentials, and status. You can also use query parameters such as limit and offset to paginate through the list of configured Webhooks. This is helpful for reviewing your existing webhook setups, managing them efficiently, and ensuring the right events are configured for callback.

Environment

Environment	Http Method	API
`Sandbox`	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/configs/v1/webhooks?limit=10&offset=0
`Production`	`GET`	https://api.phonepe.com/apis/pg/configs/v1/webhooks?limit=10&offset=0

Request

Request Headers

Header Name	Header Value	Description
`Content-Type`	application/json
`Authorization`	O-Bearer <access_token>	Pass `access_token` received in Authorization call

Response

Response Headers

Header Name	Header Value
`Content-Type`	application/json

Sample Response for case 1: Success Response

{
    "webhooks": [
        {
            "id": "CF2410212252436169514926",
            "url": "https://webhook.site/f9c9b854-72f1-462a-b28e-e3e9e4dee939",
            "description": "Webhook description",
            "username": "username",
            "password": "password123",
            "events": [
                "pg.order.completed",
                "pg.order.failed"
            ],
            "createdAt": 1729531363628,
            "updatedAt": 1729531363632,
            "enabled": true
        },
        {
            "id": "CF2410212252436169514256",
            "url": "https://webhook.site/f9c9b887-72f1-232a-b28e-e3e9e4dee121",
            "description": "Webhook description",
            "username": "username123",
            "password": "password456",
            "events": [
                "checkout.order.completed",
                "checkout.order.failed"
            ],
            "createdAt": 1729531363628,
            "updatedAt": 1729531363632,
            "enabled": true
        }
    ]
}

Sample Response for case 2: Failed with Invalid Auth Token

{
    "code": "AUTHORIZATION_FAILED",
    "message": "Authorization failed [message = Please check the authorization token and try again]"
}

Sample Response for case 3: Internal Server Error

{
    "code": "INTERNAL_SERVER_ERROR",
    "message": "There is an error trying to process your transaction at the moment. Please try again in a while."
}

Field Name	Data Type	Description
`webhooks`	Array	List of webhook configs
`id`	String	Unique identifier of the webhook. This ID can be used to update or delete the webhook.
`url`	String	The secure HTTPS endpoint where PhonePe will send webhook event notifications.
`description`	String	A brief description to identify the purpose or context of the webhook URL.
`username`	Long	Username must be 5 to 20 characters long and alphanumeric.
`password`	String	Password must be 8 to 20 characters long, alphanumeric, and include both letters and numbers.
`events`	Array	List of webhook events for which you want to receive callbacks.
`createdAt`	Long	Epoch timestamp indicating when the webhook was created.
`updatedAt`	Long	Epoch timestamp indicating the last time the webhook was updated.
`enabled`	Boolean	Flag to indicate whether the webhook is currently active or not.