--- title: Starting processes description: In this article, you will discover how to run workflow-based processes in the Gamfi application using the API. --- [Skip to content](https://gamfi.support/help/starting-processes#main-content) - [English](https://gamfi.support/help/starting-processes) - [Polski](https://gamfi.support/pl/help/starting-processes) English Show submenu for translations [Customer portal](https://gamfi.support/tickets?hsLang=en) ![Logo-gamfi\_orange.png\]](https://gamfi.support/hs-fs/hubfs/Logo-gamfi_orange.png?height=40&name=Logo-gamfi_orange.png) - [Knowledge base](https://gamfi.support/help) Open main navigation Close main navigation - [Knowledge base](https://gamfi.support/help) - - [English](https://gamfi.support/help/starting-processes) - [Polski](https://gamfi.support/pl/help/starting-processes) English Show submenu for translations - [Customer portal](https://gamfi.support/tickets) - [Go to gamfi.com](https://gamfi.com/) [Go to gamfi.com](https://gamfi.com/) Hello. How can we help you? - There are no suggestions because the search field is empty. 1. [Knowledge base](https://gamfi.support/help?hsLang=en) 2. [Gamfi API Docs](https://gamfi.support/help/gamfi-api-docs?hsLang=en) 3. [Process and workflow management](https://gamfi.support/help/gamfi-api-docs?hsLang=en#process-and-workflow-management) # Starting processes ## In this article, you will discover how to run workflow-based processes in the Gamfi application using the API. To start the process in the Gamfi application use the method and endpoint: `POST` + `/api/workflows/admin/integration/process` Example cURL: ``` curl --location 'https://{app_name}.gamfi.io/api/workflows/admin/integration/process' \--header 'X-Samus-Authorization-Api-Key: {apiKey} ' \--header 'X-Samus-Authorization-Api-Secret: {apiSecret} ' \--header 'Content-Type: application/json' \--data-raw '{ "employee_email": "john.doe@gamfi.com",  "workflow_id": "3f9a81c3-132c-4660-b459-2226805b1d80",  "key_date": "2024-01-01"}' ``` In place: - **{app\_name}** - insert the name of your application - **{apiKey}** - insert API key - **{apiSecret}** - insert API secret The request structure should contain the following data: - "**employee\_email**": the email address of the user for whom you are running the process - "**workflow\_id**": ID of the workflow, based on which you want to run the process - **"key\_date**": the key date in the process in the format YYYY-MM-DD In addition, you can pass more datatypes within the request, such as: - "**employee\_forename**": user's name - "**employee\_surname**": the user's last name - "**employee\_phone**": the user's phone number - "**employee\_company**": the user's company ID (check [Getting list of companies)](https://gamfi.support/help/getting-list-of-companies?hsLang=en) And also (optionally) many other data points, such as: - additional roles involved in the process (e.g. Manager, HRBP, IT, etc.) – known in Gamfi as “Roles” - employee categories used to personalize actions within the process (e.g. region, department, branch) – known in Gamfi as “Categories” - custom values (e.g. SAP number, job position) – known in Gamfi as “Custom Fields” Example URL: ``` curl --location 'https://{app_name}.gamfi.io/api/workflows/admin/integration/process' \--header 'X-Samus-Authorization-Api-Key: {apiKey} ' \--header 'X-Samus-Authorization-Api-Secret: {apiSecret} ' \--header 'Content-Type: application/json' \--data-raw '{  "employee_forename": "John",  "employee_surname": "Doe",  "employee_email": "john.doe@gamfi.com", "employee_phone": "+48123123123", "roles": [ { "role_id": "22d864fd-de63-4c25-be0a-b42a94bfeb6a", "user_forename": "Jane", "user_surname": "Doe", "user_email": "jane.doe@gamfi.com", "user_phone": "+48123123123" }], "employee_categories": [ { "category_id": "094f1129-6af3-4687-aa86-acbc7bb97ef7", "options": [ { "id": "b85059a4-3691-43cc-bd46-170e1e7eaa22" } ] }], "employee_custom_fields": [ { "custom_field_id": "781bd8db-e310-4fab-b68a-cead1b987918", "value": "string" } ]}' ``` If the answer is correct, you will receive a status (200). ⚠️ If the user (employee / manager, HRBP, etc.) does not have an account with Gamfi, starting the process will create a new account using the details provided.   - [Getting started](https://gamfi.support/help/getting-started?hsLang=en#main-content) - [Get to know the Gamfi app](https://gamfi.support/help/getting-started?hsLang=en#get-to-know-the-gamfi-app) - [User portal](https://gamfi.support/help/getting-started?hsLang=en#user-portal) - [Admin panel](https://gamfi.support/help/getting-started?hsLang=en#admin-panel) - [Basic technical requirements](https://gamfi.support/help/getting-started?hsLang=en#basic-technical-requirements) - [Set a standard - create a Workflow](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#main-content) - [Workflow - Process template](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#workflow-process-template) - [Actions - the "puzzles" that make up the Workflow](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#actions-the-puzzles-that-make-up-the-workflow) - [Locations and Categories - match Workflow to employee type](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#locations-and-categories-match-workflow-to-employee-type) - [Knowledge base - create a document database](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#knowledge-base-create-a-document-database) - [User segment](https://gamfi.support/help/set-a-standard-create-a-workflow?hsLang=en#user-segment) - [Automatise and scale Processes](https://gamfi.support/help/automatise-and-scale-processes?hsLang=en#main-content) - [Run the Process - release the Actions scheduled in Workflow](https://gamfi.support/help/automatise-and-scale-processes?hsLang=en#run-the-process-release-the-actions-scheduled-in-workflow) - [Manage Processes](https://gamfi.support/help/automatise-and-scale-processes?hsLang=en#manage-processes) - [Use Roles - involve other actors in the Process](https://gamfi.support/help/automatise-and-scale-processes?hsLang=en#use-roles-involve-other-actors-in-the-process) - [Education, Engagement and Communication](https://gamfi.support/help/education-engagement-and-communication?hsLang=en) - [Reports](https://gamfi.support/help/reports?hsLang=en#main-content) - [Reports in Admin Panel](https://gamfi.support/help/reports?hsLang=en#reports-in-admin-panel) - [Reports in User Portal](https://gamfi.support/help/reports?hsLang=en#reports-in-user-portal) - [Gamfi API Docs](https://gamfi.support/help/gamfi-api-docs?hsLang=en#main-content) - [People management](https://gamfi.support/help/gamfi-api-docs?hsLang=en#people-management) - [Process and workflow management](https://gamfi.support/help/gamfi-api-docs?hsLang=en#process-and-workflow-management) - [Downloading reports](https://gamfi.support/help/gamfi-api-docs?hsLang=en#downloading-reports) - [Knowledge base](https://gamfi.support/help) [![Chill listening crop-3](https://gamfi.support/hs-fs/hubfs/Logo-gamfi_orange-1.png?width=82&height=24&name=Logo-gamfi_orange-1.png "Chill listening crop-3")](http://gamfi.com) Copyright © 2025, Gamfi