Create Message

v1.0.0

Creates a new message and dispatches it to all of the application's endpoints.

The eventId is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same eventId already exists for any application in your environment, a 409 conflict error will be returned.

The eventType indicates the type and schema of the event. All messages of a certain eventType are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have channels, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.

The payload property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.

The optional application property will be used to create an application if the application referenced in the path does not exist. If it does then this property is ignored.

Input

{
  "type": "object",
  "properties": {
    "app_id": {
      "type": "string",
      "description": "The application's ID or UID"
    },
    "application": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "metadata": {
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "rateLimit": {
          "type": "integer"
        },
        "uid": {
          "type": "string",
          "description": "Optional unique identifier for the application"
        }
      }
    },
    "channels": {
      "type": "array",
      "description": "List of free-form identifiers that endpoints can filter by",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "type": "string",
      "description": "Optional unique identifier for the message"
    },
    "eventType": {
      "type": "string"
    },
    "idempotency-key": {
      "type": "string",
      "description": "The request's idempotency key"
    },
    "payload": {
      "type": "object"
    },
    "payloadRetentionPeriod": {
      "type": "integer",
      "description": "The retention period for the payload (in days)."
    },
    "with_content": {
      "type": "boolean"
    }
  },
  "required": [
    "app_id",
    "eventType",
    "payload"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "eventType",
    "id",
    "payload",
    "timestamp"
  ],
  "properties": {
    "channels": {
      "type": "array",
      "description": "List of free-form identifiers that endpoints can filter by",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "type": "string",
      "description": "Optional unique identifier for the message"
    },
    "eventType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "payload": {
      "type": "object"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  }
}