Successful Response

APIs.ioEngineeringPlatform

Properties

Name Type Description
webhook object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-createwebhookresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/createWebhookResponse",
  "title": "Successful Response",
  "type": "object",
  "properties": {
    "webhook": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The webhook's ID.",
          "example": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9"
        },
        "name": {
          "type": "string",
          "description": "The webhook's name.",
          "example": "Test Webhook"
        },
        "collection": {
          "type": "string",
          "format": "uid",
          "description": "The unique ID of the collection that triggers when calling this webhook.",
          "example": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
        },
        "webhookUrl": {
          "type": "string",
          "description": "The webhook's URL.",
          "example": "https://newman-api.getpostman.com/run/12345678/267a6e99-b6da-407c-a96f-03be2d6282fb"
        },
        "uid": {
          "type": "string",
          "format": "uid",
          "description": "The webhook's unique ID.",
          "example": "12345678-1f0df51a-8658-4ee8-a2a1-d2567dfa09a9"
        }
      }
    }
  }
}