Create Endpoint

v1.0.0

Create a new endpoint for the application.

When secret is null the secret is automatically generated (recommended)

Input

{
  "type": "object",
  "properties": {
    "app_id": {
      "type": "string",
      "description": "The application's ID or UID"
    },
    "channels": {
      "type": "array",
      "description": "List of message channels this endpoint listens to (omit for all)",
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "string"
    },
    "disabled": {
      "type": "boolean"
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "idempotency-key": {
      "type": "string",
      "description": "The request's idempotency key"
    },
    "metadata": {
      "type": "object"
    },
    "rateLimit": {
      "type": "integer"
    },
    "secret": {
      "type": "string",
      "description": "The endpoint's verification secret. If `null` is passed, a secret is automatically generated. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. Recommended size: 24."
    },
    "uid": {
      "type": "string",
      "description": "Optional unique identifier for the endpoint"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "version": {
      "type": "integer"
    }
  },
  "required": [
    "app_id",
    "url",
    "version"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "createdAt",
    "id",
    "updatedAt",
    "url",
    "version"
  ],
  "properties": {
    "channels": {
      "type": "array",
      "description": "List of message channels this endpoint listens to (omit for all)",
      "items": {
        "type": "string"
      }
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string"
    },
    "disabled": {
      "type": "boolean"
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "rateLimit": {
      "type": "integer"
    },
    "uid": {
      "type": "string",
      "description": "Optional unique identifier for the endpoint"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "version": {
      "type": "integer"
    }
  }
}