--- title: "Event-Based Gateway" slug: "event-based-gateway" updated: 2025-12-22T22:59:34Z published: 2025-12-22T22:59:34Z canonical: "docs.processmaker.com/event-based-gateway" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.processmaker.com/llms.txt > Use this file to discover all available pages before exploring further. # Event-Based Gateway > [!TIP] > [**Plan Availability:**](https://www.processmaker.com/products/pricing/) ![Professional](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Standard.png)![Professional](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Professional.png)![Enterprise](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Enterprise.png) An Event-Based Gateway object evaluates a Request's workflow routing for a Process based on which event occurs immediately after the Event-Based Gateway object. Follow these guidelines to use the Event-Based Gateway object: - The Event-Based Gateway object requires two or more outgoing Sequence Flow objects. When evaluating events, workflow routes through only one Sequence Flow object; multiple events cannot pass simultaneously from one Event-Based Gateway object during a Request. - The Event-Based Gateway object can only connect with Intermediate Timer Event or Intermediate Message Catch Event objects. This creates the scenario that either a timed event occurs or an Intermediate Message Catch Event object receives a message. When the Event-Based Gateway object triggers during a Request, workflow for that Request pauses. ProcessMaker Platform then evaluates the events immediately following the Event-Based Gateway object's via its outgoing Sequence Flow objects and waits until one of those events occur. Request workflow resumes by routing to the event that occurs first. Consider the following example. Suppose that you have a Process that monitors if you receive package shipments on time. Use an Event-Based Gateway object to monitor which event occurs next. Refer to the Process modeling objects below. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/cc73f29a-f5ba-43ec-bcfd-69caaf5160ee.png) Event-Based Gateway object example In this example, connect the following Process modeling objects from the Event-Based Gateway object: - **Intermediate Timer Event object:** The first connecting event from the Event-Based Gateway object is an Intermediate Timer Event object that is set to 24 hours. This event represents a 24-hour period in which presumably a notification has not arrived that the package shipped within that time period. If the timer set in the Intermediate Timer Event expires, then workflow routes to a Manual Task object in which its assignee telephones the shipping company. - **Intermediate Message Catch Event object:** The second connecting object is an Intermediate Message Catch Event object that represents a notification of the package’s shipment presumably before the timer set in the Intermediate Timer Event object expires. If the Intermediate Message Catch Event object triggers, then the notification was received before the 24-hour period expired. No further action is required. --- ## Add an Event-Based Gateway to the Process Model **Permissions** Your user account or group membership must have the following permissions to configure an Event-Based Gateway object in the Process model unless your user account has the **Make this user a Super Admin** setting selected: - Processes: Edit Processes - Processes: View Processes See the [Process](/v1/docs/permission-descriptions-for-users-and-groups#processes) permissions or ask your Administrator for assistance. Add an Event-Based Gateway object from one of the following locations in Process Modeler: - **Object Panel:** Located to the left of the Process Modeler, the Object Panel contains various process modeling objects. - **Object Bar:** Located at the bottom of the Process Modeler, the Object Bar contains [pinned](/v1/docs/process-modeler#pin-and-unpin-objects) Process modeling objects for quick access. Add from the Object panelAdd from the Object bar Follow these steps to add a Event Based Gateway from the Object panel to the Process model: 1. Ensure that the Object panel is visible. If not, click the **Add** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/5c9bfa32-c73d-4ed5-921e-b6b8bb5948df.png) from the Object bar at the bottom. 2. Click the **Gateway** object ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/9f6292af-b922-41b6-8116-744f609222e0.png) from the Object panel to select it. 3. Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool. 4. Click the **Objects** drop-down menu, and then select the **Event Based Gateway** option. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/3afeabd4-e56f-47f8-856c-babb8638e4cd.png) The Event Based Gateway object displays. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/055db0f9-3527-485d-a600-b88247cf8e12.png) Follow these steps to add an Event-Based Gateway object from the Object bar to the Process model: 1. Ensure that the Gateway object is pinned to the Object bar. If not, [see instructions to pin it](/v1/docs/process-modeler#pin-and-unpin-objects). 2. In the Object bar at the bottom center, click the object's icon. 3. Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool. 4. Click the **Objects** drop-down menu, and then select the **Event-Based Gateway** option. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/3afeabd4-e56f-47f8-856c-babb8638e4cd.png) The Event-Based Gateway object displays. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/055db0f9-3527-485d-a600-b88247cf8e12.png) **Adjust location and appearance** - [Move a Process Model Object.](/v1/docs/process-modeler#move-process-model-objects) - [Connect Two Process Model Objects with a Sequence Flow Element.](/v1/docs/sequence-flow-element#connect-two-process-model-objects-with-a-sequence-flow-element) - [Customize the Appearance of a Process Model Object.](/v1/docs/customize-the-appearance-of-a-process-model-object) - [Copy Process Model Objects into the Clipboard.](/v1/docs/process-modeler#copy-process-model-objects-into-the-clipboard) - [Clone Process Model Objects Without the Clipboard.](/v1/docs/process-modeler#clone-process-model-objects) - [Delete Process Model Objects.](/v1/docs/process-modeler#delete-process-model-objects) ## Replace an Event-Based Gateway Object with a Different Gateway Object After an Event-Based Gateway object is [added to a Process model](/v1/docs/event-based-gateway#add-an-event-based-gateway-element), you may replace it with a different Gateway type object: - [Exclusive Gateway](/v1/docs/exclusive-gateway) object - [Inclusive Gateway](/v1/docs/inclusive-gateway) object - [Parallel Gateway](/v1/docs/parallel-gateway) object The selected Event-Based Gateway object is replaced by the default settings and color of the replacing object. Follow these steps to replace an Event-Based Gateway object with a different Gateway type object: 1. Select the Event-Based Gateway object to change to another object. Available options display above the selected object. 2. Click the **Objects** icon. The **Objects** drop-down menu displays the Gateway type objects. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/94ce77ee-48dc-4866-9ab3-faeab0be1402.png) 3. Select the object to replace the Event-Based Gateway object. The **Change Type** screen displays to confirm replacing the currently selected object. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/8660e78a-5841-4e9c-9b21-0871729069e7.png) 4. Click **Confirm**. The new object replaces the Event-Based Gateway object with its default settings and color. --- ## Settings The Event-Based Gateway object has the following panels that contain settings: - [**Configuration**](/v1/docs/event-based-gateway#configuration-panel-settings) panel - [**Documentation**](/v1/docs/event-based-gateway#documentation-panel-settings) panel - [**Advanced**](/v1/docs/event-based-gateway#advanced-panel-settings) panel --- ### Configuration Panel Settings #### Edit the Object Name An object name is a human-readable reference for a Process object. Process Modeler automatically assigns the name of a Process object with its object type. However, an object's name can be changed. Follow these steps to edit the name for an Event-Based Gateway object: 1. Select the Event-Based Gateway object from the Process model in which to edit its name. 2. Ensure that the **Configuration** panel displays. If not, [show it](/v1/docs/show-configuration-settings-for-a-process-model-object). The **Name** setting displays. This is a required setting. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/e3b756de-bcc1-4b85-a17e-12e15118aa6e.png) 3. In the **Name** setting, edit the selected object's name and then press **Enter**. --- ### Documentation Panel Settings Describe the object's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the object is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor. A Process's entered documentation displays by selecting the [**View Documentation** icon for that Process](/v1/docs/view-documentation-for-a-process). #### Edit the Object's Description Displayed in Process Documentation Follow these steps to edit the description for an object: 1. Select the object from the Process model in which to edit its description. Panels to configure this object display. 2. Expand the **Documentation** panel if it is not presently expanded. The **Description** setting displays. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/174fe75f-5b2c-46e0-b038-4de0197fa04f.png) 3. In the **Description** setting, edit the information to display when viewing documentation for this object and then press **Enter**. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the **More** icon![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/4842fa35-c9aa-4976-a715-e630817f80ff.png). ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/a9a2ed33-a479-41c7-bb2e-c01abd3e9010.png) Follow these guidelines to use the WYSIWYG rich text editor to stylize your text: - **Undo changes:** Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/c0929cc8-0e38-4fd0-9cd5-67021ac934b0.png)icon to undo the last action. - **Redo changes:** Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/75740045-71f5-4b49-9599-191b5198f4fa.png)icon to redo the last undone action. - **Insert/Edit Link**: Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/175deb30-5804-44c3-93cd-a7d6df4c6725.png)icon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink: 1. Select the required text from the Rich Text control. 2. Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/175deb30-5804-44c3-93cd-a7d6df4c6725.png)icon. The **Insert/Edit Link** screen displays. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/97f30cf4-e7d2-471a-a3e7-c28f3bdaa04e.png) 3. In the **URL** setting, enter the destination URL. 4. In the **Text to display** setting, edit or enter the text displayed in the Rich Text control. 5. In the **Title** setting, enter the text to display when a user hovers over the displayed text. 6. From **Open link in…** drop-down menu, select one of these options: - **New window**: Select this option to open the destination page in a new browser window. - **Current window**: Select this option to open the destination page in the current browser window. - **Insert/Edit Image:** Click on the **Insert/Edit Image** icon![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/2132eb1b-b76c-40b9-8df1-b359288577f6.png)to insert an image. Follow these guidelines: 1. Click on the **Insert/Edit Image** icon![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/2132eb1b-b76c-40b9-8df1-b359288577f6.png). 2. The **Insert/Edit Image** screen displays: ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/dc26b225-5af3-4e03-873a-d44cff204bef.png) 3. In the **Source** setting, enter a URL for the image. 4. In the **Alternative Description** setting, enter the text to display if the source URL of the image is not accessible. 5. In the **Width** setting, enter the maximum width for the image. 6. In the **Height** setting, enter the maximum height for the image. 7. Toggle the **Constrain Proportions** icon![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/3a440523-37a0-4693-af28-588ede4cc48b.png)to maintain the width-height ratio of the image to its original proportion. 8. Click **Save**. - **Insert Page Break for PDF:** Click on the **Insert Page Break for PDF** icon![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/bb0a592e-dc6e-4c18-a400-f0660f4de54a.png)to insert a page break when a PDF document is created for this documentation if your browser supports this feature. - **Format text**: Follow these guidelines to format text: - **Headings**: From the **Paragraph/Formats** menu, select **Headings** and then select a heading size. - **Bold:** Do one of the following: - From the editor toolbar, select the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/cd470a8e-0e81-4eaa-8755-1dc73fa5ca54.png)icon. - From the **Paragraph/Formats** menu, select **Inline** and then **Bold**. - **Italics:** Do one of the following: - From the editor toolbar, select the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/92b393f9-7f7c-4ed9-ab21-8cc18f6d072e.png)icon. - From the **Paragraph/Formats** menu, select **Inline** and then **Italic**. - **Underline**: From the **Paragraph/Formats** menu, select **Inline** and then **Underline**. - **Strikethrough**: From the **Paragraph/Formats** menu, select **Inline** and then **Strikethrough**. - **Superscript**: From the **Paragraph/** **Formats** menu, select **Inline** and then **Superscript**. - **Subscript**: From the **Paragraph/Formats** menu, select **Inline** and then **Subscript**. - **Code**: From the **Paragraph/Formats** menu, select Inline and then **Code**. - **Paragraph**: From the **Paragraph/Formats** menu, select **Blocks** and then **Paragraph**. - **Blockquote**: From the **Paragraph/Formats** menu, select **Blocks** and then **Blockquote**. - **Division**: From the **Paragraph/Formats** menu, select **Blocks** and then **Div**. - **Preformatted**: From the **Paragraph/Formats** menu, select **Blocks** and then **Pre**. - **Change text color**: Use the **Text Color** drop-down to change text color. Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/f82fde7f-a7ec-4bde-b843-5137d5e8ef26.png)icon. The color palette displays. Do one of the following: - Select one of the color swatches from the color palette. The selected text changes to that color. - Click the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/338e0832-e103-4bcf-9cd4-bcb5d54dd38c.png)icon to select a custom color from the **Color Picker**. - Click the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/73b3dd45-0de2-4da6-a180-4ed7ee5746c6.png)icon to reset the text to its default color. - **Align text**: Follow these guidelines to align text: - **Left align:** Do one of the following: - From the editor toolbar, use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/fc4e4dcb-0153-41bc-ba1a-989dda18cb53.png)icon to left-align text. - From the **Paragraph/Formats** menu, select **Align** and then **Left**. - **Center align:** Do one of the following: - From the editor toolbar, use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/15faef9d-e44b-4a6d-8036-0865da26c33d.png)icon to center-align text. - From the **Paragraph/Formats** menu, select **Align** and then **Center**. - **Right align**: Do one of the following: - From the editor toolbar, use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/3e86ea37-1fa5-42f6-b6d4-7eb26b6302d6.png)icon to right-align text. - From the **Paragraph/Formats** menu, select **Align** and then **Right**. - **Justify**: Do one of the following: - From the editor toolbar, use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/473ddb0d-a76e-44d9-bad6-ca770ae4ceae.png)icon to justify text. - From the **Paragraph/Formats** menu, select **Align** and then **Justify**. - **Insert a bullet list**: Use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/c50c9fab-7447-4406-9567-e74f2c375a85.png)icon to format text as a bulleted list. - **Insert a numbered list:** Use the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/17626984-137c-4aa9-a80b-5ca7fc537840.png)icon to format text as a numbered list. - **Indent text**: Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/64c263f1-1628-436d-89ca-d06bffaecdad.png)icon to increase text indenting. - **Outdent text:** Click on the![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/510b6dac-c740-440e-beb6-c55272ab3f32.png)icon to decrease text indenting. --- ### Advanced Panel Settings #### Edit the Node's Identifier Value Process Modeler automatically assigns a unique vEdit the Object's Description Displayed in Process Documentationalue to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value. > [!WARNING] > All identifier values for all nodes in the Process model must be unique. Follow these steps to edit the identifier value for an Event-Based Gateway object: 1. Select the Event-Based Gateway object from the Process model in which to edit its identifier value. 2. Ensure that the **Configuration** panel displays. If not, [show it](/v1/docs/show-configuration-settings-for-a-process-model-object). Panels to configure this object display. 3. Expand the **Advanced** panel if it is not presently expanded. The **Node Identifier** setting displays. This is a required setting. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/aac06111-c9d5-4ebd-9b34-3fa3b037b467.png) 4. In the **Node Identifier** setting, edit the Event-Based Gateway object's identifier to a unique value from all nodes in the Process model and then press **Enter**.