Solid Commerce Docs
GET/v1/platform/webhooks/{id}

GET /v1/platform/webhooks/{id}

Scopes: platform:webhooks:read

Requires scope: platform:webhooks:read.

Parameters

NameInTypeRequiredDescription
idpathstring<uuid>yes

Response (200)

FieldTypeRequiredDescription
idstring<uuid>no
urlstringno
event_typesstring[]no
descriptionstringno
statusstringno
consecutive_failure_countinteger<int32>no
auto_disabled_atstring<date-time>no
created_atstring<date-time>no
updated_atstring<date-time>no

Examples

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
  apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

const { data, error } = await client.raw.GET('/v1/platform/webhooks/{id}', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

if (error) throw error;
console.log(data);