object EventTypeImportOpenApiOutData
{
  "type": "object",
  "required": [
    "modified"
  ],
  "properties": {
    "modified": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      }
    }
  }
}
object EventTypeIn
{
  "type": "object",
  "required": [
    "description",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    },
    "schemas": {
      "type": "object",
      "example": {
        "1": {
          "type": "object",
          "title": "Invoice Paid Event",
          "required": [
            "invoiceId",
            "userId"
          ],
          "properties": {
            "userId": {
              "type": "string",
              "description": "The user id"
            },
            "invoiceId": {
              "type": "string",
              "description": "The invoice id"
            }
          },
          "description": "An invoice was paid by a user"
        }
      },
      "nullable": true,
      "description": "The schema for the event type for a specific version as a JSON schema.",
      "additionalProperties": {
        "type": "object"
      }
    },
    "archived": {
      "type": "boolean",
      "default": false,
      "example": false
    },
    "description": {
      "type": "string",
      "example": "A user has signed up"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    }
  }
}
object EventTypeOut
{
  "type": "object",
  "required": [
    "createdAt",
    "description",
    "name",
    "updatedAt"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    },
    "schemas": {
      "type": "object",
      "example": {
        "1": {
          "type": "object",
          "title": "Invoice Paid Event",
          "required": [
            "invoiceId",
            "userId"
          ],
          "properties": {
            "userId": {
              "type": "string",
              "description": "The user id"
            },
            "invoiceId": {
              "type": "string",
              "description": "The invoice id"
            }
          },
          "description": "An invoice was paid by a user"
        }
      },
      "nullable": true,
      "description": "The schema for the event type for a specific version as a JSON schema.",
      "additionalProperties": {
        "type": "object"
      }
    },
    "archived": {
      "type": "boolean",
      "default": false,
      "example": false
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string",
      "example": "A user has signed up"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    }
  }
}
object EventTypePatch
{
  "type": "object",
  "properties": {
    "schemas": {
      "type": "object",
      "example": {
        "type": "object",
        "title": "Invoice Paid Event",
        "required": [
          "invoiceId",
          "userId"
        ],
        "properties": {
          "userId": {
            "type": "string",
            "description": "The user id"
          },
          "invoiceId": {
            "type": "string",
            "description": "The invoice id"
          }
        },
        "description": "An invoice was paid by a user"
      },
      "nullable": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "archived": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    }
  }
}
object EventTypeUpdate
{
  "type": "object",
  "required": [
    "description"
  ],
  "properties": {
    "schemas": {
      "type": "object",
      "example": {
        "1": {
          "type": "object",
          "title": "Invoice Paid Event",
          "required": [
            "invoiceId",
            "userId"
          ],
          "properties": {
            "userId": {
              "type": "string",
              "description": "The user id"
            },
            "invoiceId": {
              "type": "string",
              "description": "The invoice id"
            }
          },
          "description": "An invoice was paid by a user"
        }
      },
      "nullable": true,
      "description": "The schema for the event type for a specific version as a JSON schema.",
      "additionalProperties": {
        "type": "object"
      }
    },
    "archived": {
      "type": "boolean",
      "default": false,
      "example": false
    },
    "description": {
      "type": "string",
      "example": "A user has signed up"
    },
    "featureFlag": {
      "type": "string",
      "example": "cool-new-feature",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256
    }
  }
}
object ExportEventTypeOut
{
  "type": "object",
  "required": [
    "id",
    "status",
    "task"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "task": {
      "$ref": "#/components/schemas/BackgroundTaskType"
    },
    "status": {
      "$ref": "#/components/schemas/BackgroundTaskStatus"
    }
  }
}
object FontSizeConfig
{
  "type": "object",
  "properties": {
    "base": {
      "type": "integer",
      "format": "uint16",
      "minimum": 0,
      "nullable": true
    }
  }
}
object GenerateIn
{
  "type": "object",
  "required": [
    "prompt"
  ],
  "properties": {
    "prompt": {
      "type": "string"
    }
  }
}
object GenerateOut
{
  "type": "object",
  "required": [
    "choices",
    "created",
    "id",
    "model",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "object": {
      "type": "string"
    },
    "choices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CompletionChoice"
      }
    },
    "created": {
      "type": "integer",
      "format": "int64"
    }
  }
}
object HTTPValidationError
{
  "type": "object",
  "required": [
    "detail"
  ],
  "properties": {
    "detail": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      }
    }
  }
}
object HttpErrorOut
{
  "type": "object",
  "title": "HttpError",
  "required": [
    "code",
    "detail"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    }
  }
}
object InboundPathParams
{
  "type": "object",
  "required": [
    "app_id",
    "inbound_token"
  ],
  "properties": {
    "app_id": {
      "type": "string",
      "example": "unique-app-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "minLength": 1,
      "description": "The app's ID or UID"
    },
    "inbound_token": {
      "type": "string"
    }
  }
}
object IntegrationIn
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example Integration"
    }
  }
}
object IntegrationKeyOut
{
  "type": "object",
  "required": [
    "key"
  ],
  "properties": {
    "key": {
      "type": "string",
      "example": "integsk_kV3ts5tKPNJN4Dl25cMTfUNdmabxbX0O"
    }
  }
}
object IntegrationOut
{
  "type": "object",
  "required": [
    "createdAt",
    "id",
    "name",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The integ's ID"
    },
    "name": {
      "type": "string",
      "example": "Example Integration"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
object IntegrationUpdate
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example Integration"
    }
  }
}
object ListResponse_ApplicationOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApplicationOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_BackgroundTaskOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BackgroundTaskOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_EndpointMessageOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EndpointMessageOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_EndpointOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EndpointOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_EventTypeOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventTypeOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_IntegrationOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IntegrationOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_MessageAttemptEndpointOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageAttemptEndpointOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_MessageAttemptOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageAttemptOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_MessageEndpointOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageEndpointOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_MessageOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object ListResponse_TemplateOut_
{
  "type": "object",
  "required": [
    "data",
    "done"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string",
      "example": "iterator",
      "nullable": true
    },
    "prevIterator": {
      "type": "string",
      "example": "-iterator",
      "nullable": true
    }
  }
}
object MessageAttemptEndpointOut
{
  "type": "object",
  "required": [
    "endpointId",
    "id",
    "msgId",
    "response",
    "responseStatusCode",
    "status",
    "timestamp",
    "triggerType",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The attempt's ID"
    },
    "msg": {
      "$ref": "#/components/schemas/MessageOut",
      "nullable": true
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/webhook/",
      "maxLength": 65536,
      "minLength": 1
    },
    "msgId": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "status": {
      "$ref": "#/components/schemas/MessageStatus"
    },
    "response": {
      "type": "string",
      "example": "{}"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "endpointId": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "triggerType": {
      "$ref": "#/components/schemas/MessageAttemptTriggerType"
    },
    "responseStatusCode": {
      "type": "integer",
      "format": "int16",
      "example": 200
    }
  }
}
object MessageAttemptExhaustedEvent
{
  "type": "object",
  "required": [
    "data",
    "type"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MessageAttemptExhaustedEventData"
    },
    "type": {
      "enum": [
        "message.attempt.exhausted"
      ],
      "type": "string",
      "default": "message.attempt.exhausted"
    }
  },
  "description": "Sent when a message delivery has failed (all of the retry attempts have been exhausted)."
}
object MessageAttemptExhaustedEventData
{
  "type": "object",
  "required": [
    "appId",
    "endpointId",
    "lastAttempt",
    "msgId"
  ],
  "properties": {
    "appId": {
      "type": "string",
      "example": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The app's ID"
    },
    "msgId": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "appUid": {
      "type": "string",
      "example": "unique-app-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The app's UID"
    },
    "endpointId": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "msgEventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The msg's UID"
    },
    "lastAttempt": {
      "$ref": "#/components/schemas/MessageAttemptFailedData"
    }
  },
  "description": "Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a \"message.attempt.exhausted\" type or after it's failed four times as a \"message.attempt.failing\" event."
}
object MessageAttemptFailedData
{
  "type": "object",
  "required": [
    "id",
    "responseStatusCode",
    "timestamp"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The attempt's ID"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "responseStatusCode": {
      "type": "integer",
      "format": "int16"
    }
  }
}
object MessageAttemptFailingEvent
{
  "type": "object",
  "required": [
    "data",
    "type"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MessageAttemptFailingEventData"
    },
    "type": {
      "enum": [
        "message.attempt.failing"
      ],
      "type": "string",
      "default": "message.attempt.failing"
    }
  },
  "description": "Sent after a message has been failing for a few times.\nIt's sent on the fourth failure. It complements `message.attempt.exhausted` which is sent after the last failure."
}
object MessageAttemptFailingEventData
{
  "type": "object",
  "required": [
    "appId",
    "endpointId",
    "lastAttempt",
    "msgId"
  ],
  "properties": {
    "appId": {
      "type": "string",
      "example": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The app's ID"
    },
    "msgId": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "appUid": {
      "type": "string",
      "example": "unique-app-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The app's UID"
    },
    "endpointId": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "msgEventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The msg's UID"
    },
    "lastAttempt": {
      "$ref": "#/components/schemas/MessageAttemptFailedData"
    }
  },
  "description": "Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a \"message.attempt.exhausted\" type or after it's failed four times as a \"message.attempt.failing\" event."
}
object MessageAttemptHeadersOut
{
  "type": "object",
  "required": [
    "sensitive",
    "sentHeaders"
  ],
  "properties": {
    "sensitive": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "sentHeaders": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "responseHeaders": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "maxItems": 2,
        "minItems": 2
      },
      "nullable": true
    }
  }
}
object MessageAttemptOut
{
  "type": "object",
  "required": [
    "endpointId",
    "id",
    "msgId",
    "response",
    "responseStatusCode",
    "status",
    "timestamp",
    "triggerType",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The attempt's ID"
    },
    "msg": {
      "$ref": "#/components/schemas/MessageOut",
      "nullable": true
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/webhook/",
      "maxLength": 65536,
      "minLength": 1
    },
    "msgId": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "status": {
      "$ref": "#/components/schemas/MessageStatus"
    },
    "response": {
      "type": "string",
      "example": "{}"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "endpointId": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "triggerType": {
      "$ref": "#/components/schemas/MessageAttemptTriggerType"
    },
    "responseStatusCode": {
      "type": "integer",
      "format": "int16",
      "example": 200
    }
  }
}
object MessageAttemptRecoveredEvent
{
  "type": "object",
  "required": [
    "data",
    "type"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MessageAttemptRecoveredEventData"
    },
    "type": {
      "enum": [
        "message.attempt.recovered"
      ],
      "type": "string",
      "default": "message.attempt.recovered"
    }
  },
  "description": "Sent on a successful dispatch after an earlier failure op webhook has already been sent."
}
object MessageAttemptRecoveredEventData
{
  "type": "object",
  "required": [
    "appId",
    "endpointId",
    "lastAttempt",
    "msgId"
  ],
  "properties": {
    "appId": {
      "type": "string",
      "example": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The app's ID"
    },
    "msgId": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "appUid": {
      "type": "string",
      "example": "unique-app-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The app's UID"
    },
    "endpointId": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "msgEventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "The msg's UID"
    },
    "lastAttempt": {
      "$ref": "#/components/schemas/MessageAttemptFailedData"
    }
  },
  "description": "Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a \"message.attempt.exhausted\" type or after it's failed four times as a \"message.attempt.failing\" event."
}
integer MessageAttemptTriggerType
{
  "enum": [
    0,
    1
  ],
  "type": "integer",
  "title": "MessageAttemptTriggerType",
  "description": "The reason an attempt was made:\n- Scheduled = 0\n- Manual = 1",
  "x-enum-varnames": [
    "Scheduled",
    "Manual"
  ]
}
object MessageBroadcastIn
{
  "type": "object",
  "required": [
    "eventType",
    "payload"
  ],
  "properties": {
    "eventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "Optional unique identifier for the message"
    },
    "payload": {
      "type": "object",
      "example": {
        "type": "user.created",
        "email": "test@example.com",
        "username": "test_user"
      }
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "example": [
        "project_123",
        "group_2"
      ],
      "maxItems": 5,
      "minItems": 1,
      "nullable": true,
      "description": "List of free-form identifiers that endpoints can filter by",
      "uniqueItems": true
    },
    "eventType": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    },
    "payloadRetentionPeriod": {
      "type": "integer",
      "format": "int64",
      "default": 90,
      "example": 90,
      "maximum": 90,
      "minimum": 5
    }
  }
}
object MessageBroadcastOut
{
  "type": "object",
  "required": [
    "id",
    "status",
    "task"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "task": {
      "$ref": "#/components/schemas/BackgroundTaskType"
    },
    "status": {
      "$ref": "#/components/schemas/BackgroundTaskStatus"
    }
  }
}
object MessageEndpointOut
{
  "type": "object",
  "required": [
    "createdAt",
    "description",
    "id",
    "status",
    "updatedAt",
    "url",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The ep's ID"
    },
    "uid": {
      "type": "string",
      "example": "unique-ep-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "Optional unique identifier for the endpoint"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/webhook/",
      "maxLength": 65536,
      "minLength": 1
    },
    "status": {
      "$ref": "#/components/schemas/MessageStatus"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "example": 1,
      "minimum": 1,
      "deprecated": true
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "example": [
        "project_123",
        "group_2"
      ],
      "maxItems": 10,
      "minItems": 1,
      "nullable": true,
      "description": "List of message channels this endpoint listens to (omit for all)",
      "uniqueItems": true
    },
    "disabled": {
      "type": "boolean",
      "default": false,
      "example": false
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "rateLimit": {
      "type": "integer",
      "format": "uint16",
      "minimum": 0,
      "nullable": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string",
      "description": "An example endpoint name"
    },
    "filterTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "user.signup",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 256,
        "description": "The event type's name"
      },
      "example": [
        "user.signup",
        "user.deleted"
      ],
      "minItems": 1,
      "nullable": true,
      "uniqueItems": true
    },
    "nextAttempt": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  }
}
object MessageIn
{
  "type": "object",
  "required": [
    "eventType",
    "payload"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "example": [
        "my_tag",
        "other"
      ],
      "maxItems": 5,
      "minItems": 1,
      "nullable": true,
      "description": "List of free-form tags that can be filtered by when listing messages",
      "uniqueItems": true
    },
    "eventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "Optional unique identifier for the message"
    },
    "payload": {
      "type": "object",
      "example": {
        "type": "user.created",
        "email": "test@example.com",
        "username": "test_user"
      }
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "example": [
        "project_123",
        "group_2"
      ],
      "maxItems": 5,
      "minItems": 1,
      "nullable": true,
      "description": "List of free-form identifiers that endpoints can filter by",
      "uniqueItems": true
    },
    "eventType": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    },
    "application": {
      "$ref": "#/components/schemas/ApplicationIn",
      "nullable": true,
      "description": "Optionally creates a new application alongside the message. If the application id or uid that is used in the path already exists, this argument is ignored."
    },
    "transformationsParams": {
      "type": "object",
      "nullable": true,
      "description": "Extra parameters to pass to Transformations (for future use)"
    },
    "payloadRetentionPeriod": {
      "type": "integer",
      "format": "int64",
      "default": 90,
      "example": 90,
      "maximum": 90,
      "minimum": 5
    }
  }
}
object MessageOut
{
  "type": "object",
  "required": [
    "eventType",
    "id",
    "payload",
    "timestamp"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "description": "The msg's ID"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "nullable": true,
      "uniqueItems": true
    },
    "eventId": {
      "type": "string",
      "example": "unique-msg-identifier",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "nullable": true,
      "maxLength": 256,
      "minLength": 1,
      "description": "Optional unique identifier for the message"
    },
    "payload": {
      "type": "object",
      "example": {
        "type": "user.created",
        "email": "test@example.com",
        "username": "test_user"
      }
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "project_1337",
        "pattern": "^[a-zA-Z0-9\\-_.]+$",
        "maxLength": 128
      },
      "example": [
        "project_123",
        "group_2"
      ],
      "maxItems": 5,
      "minItems": 1,
      "nullable": true,
      "description": "List of free-form identifiers that endpoints can filter by",
      "uniqueItems": true
    },
    "eventType": {
      "type": "string",
      "example": "user.signup",
      "pattern": "^[a-zA-Z0-9\\-_.]+$",
      "maxLength": 256,
      "description": "The event type's name"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  }
}
object MessageRawPayloadOut
{
  "type": "object",
  "required": [
    "payload"
  ],
  "properties": {
    "payload": {
      "type": "string",
      "example": "{\"email\":\"test@example.com\",\"type\":\"user.created\",\"username\":\"test_user\"}"
    }
  }
}
integer MessageStatus
{
  "enum": [
    0,
    1,
    2,
    3
  ],
  "type": "integer",
  "title": "MessageStatus",
  "description": "The sending status of the message:\n- Success = 0\n- Pending = 1\n- Fail = 2\n- Sending = 3",
  "x-enum-varnames": [
    "Success",
    "Pending",
    "Fail",
    "Sending"
  ]
}
object MessageStreamOut
{
  "type": "object",
  "required": [
    "data",
    "done",
    "iterator"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageOut"
      }
    },
    "done": {
      "type": "boolean"
    },
    "iterator": {
      "type": "string"
    }
  }
}
object OauthPayloadIn
{
  "type": "object",
  "required": [
    "code",
    "redirectUri"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "redirectUri": {
      "type": "string"
    }
  }
}
object OauthPayloadOut
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "nullable": true
    },
    "channel": {
      "type": "string",
      "nullable": true
    },
    "incomingWebhookUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}
object OneTimeTokenIn
{
  "type": "object",
  "required": [
    "oneTimeToken"
  ],
  "properties": {
    "oneTimeToken": {
      "type": "string"
    }
  }
}
object OneTimeTokenOut
{
  "type": "object",
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string"
    }
  }
}
Load more schemas