> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Trigger a user journey

> Start a user journey for the specified users.

> [!WARNING]
>
> **Requirement**
>
> To start a user journey with the HTTP API, set its entry type to **API Triggered Entry**.


## OpenAPI

````yaml /en/api-reference/openapi.yaml post /projects/{projectId}/user-journeys/{userJourneyId}/enter
openapi: 3.0.3
info:
  title: Notifly API
  version: 1.0.0
  contact:
    email: contact@notifly.tech
servers:
  - url: https://api.notifly.tech
    description: Notifly API server
security: []
tags:
  - name: catalog
    x-group: Catalogs
paths:
  /projects/{projectId}/user-journeys/{userJourneyId}/enter:
    post:
      summary: trigger-user-journey
      operationId: triggerUserJourney
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID.
        - name: userJourneyId
          in: path
          required: true
          schema:
            type: string
          description: User journey ID from the console.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - users
              properties:
                users:
                  type: array
                  items:
                    type: object
                    required:
                      - userId
                    properties:
                      userId:
                        type: string
                        description: ID of the user who will enter the journey.
                      eventParams:
                        type: object
                        description: >-
                          Object containing event parameters used to personalize
                          messages.
                  description: Users who will enter the journey. Up to 1,000 entries.
            example:
              users:
                - userId: alice
      responses:
        '200':
          description: The user journey was triggered.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  success:
                    type: boolean
                  error:
                    type: string
                    nullable: true
              example:
                code: 200
                success: true
                error: null
        '400':
          description: The request body format is invalid.
          content:
            application/json:
              schema:
                $ref: aea8cddf-64cd-4f62-8842-454c8f3a6bf3
        '401':
          description: Authentication failed because the token is invalid or expired.
          content:
            application/json:
              schema:
                $ref: aea8cddf-64cd-4f62-8842-454c8f3a6bf3
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: aea8cddf-64cd-4f62-8842-454c8f3a6bf3
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Pass the token issued by `POST /authenticate` as a bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.