Show WebhookEvent entity.

Fetches a WebhookEvent entity.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.webhookEvents.get({
  id: 0,
});

Responses

200404

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": "id",
    "event": "event",
    "subjectId": 0,
    "webhook": {
      "id": 0,
      "url": "url",
      "secret": "secret",
      "description": "description",
      "events": [],
      "active": true
    },
    "payload": [],
    "status": "pending",
    "responseStatusCode": 0,
    "attempts": 0,
    "error": "error"
  }
]

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

• idnumberrequired

Returns

Array of WebhookEvent

Schema shown for 200 · application/json

• idstring
• eventstring
• subjectIdnumber
• payloadobjectoptional
• statusstringoptional
  Default: "pending"
• responseStatusCodenumberoptional
• attemptsnumberoptional
  Default: 0
• errorstringoptional
• webhookWebhook
  Show 6 properties

  • idnumber
  • descriptionstringoptional
  • urlstring
  • secretstring
  • eventsstring[]optional
  • activebooleanoptional
    Default: true