Create Webhook entity.

Creates a new Webhook entity. The webhook receives a POST request for every subscribed event. The response contains the generated secret used to sign every delivery — store it to verify that deliveries come from Recranet. The URL must be https and publicly resolvable.

POSTRequest

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

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

const result = await client.webhooks.create({
  url: "<url>",
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "url": "url",
  "secret": "secret",
  "description": "description",
  "events": [],
  "active": true
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Request body

Required

Yes

Content type

• application/json

• descriptionstringoptional
• urlstringrequired
• eventsstring[]optional
• activebooleanoptional
  Default: true

Returns

Schema shown for 200 · application/json

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