Get Webhook Details

Get detailed information about a specific webhook.

GET /webhooks/{webhook_id}

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const webhookDetails = await client.webhooks.retrieve('webhook_id');

console.log(webhookDetails.id);

200

{
  "created_at": "<string>",
  "description": "<string>",
  "id": "<string>",
  "metadata": {},
  "updated_at": "<string>",
  "url": "<string>",
  "disabled": true,
  "filter_types": [
    "<string>"
  ],
  "rate_limit": 1
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhook_id · string · required

Response

200

application/json

Webhook details retrived.

created_at · string · required

Created at timestamp

description · string · required

An example webhook name.

id · string · required

The webhook's ID.

metadata · object · required

Metadata of the webhook

Show child attributes

updated_at · string · required

Updated at timestamp

url · string · required

Url endpoint of the webhook

disabled · boolean | null

Status of the webhook.

If true, events are not sent

filter_types · string[] | null

Filter events to the webhook.

Webhook event will only be sent for events in the list.

rate_limit · integer<int32> | null

Configured rate limit

Required range: x >= 0