---
category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Workday Extend, Platform and Product Extensions/Integration]
keyword: [Extend, Model Components, Extend BPs, Extend Business Processes, Model Business Processes, Extend BP]
nav: wcp_docs
parent_url: /wcp_docs/
title: >- 
  Reference: Business Process Event API Requests
layout: subsection
---

<a id="section_N10021_N1001E_N10001"></a>
Each business process that you create generates an API in the form of:

```
https://{basePath}/apps/{appId}/v1/{businessProcessName}Events
```

where:

-   `{basePath}`: The regional URL base path.
-   `{appId}`: The reference ID of the Extend app.
-   `{businessProcessName}`: The `name` of the business process you created for your app. Example: <i>CreateCharity</i>.


To initiate the business process, call the POST method of the Business Process Event API. Reference the target business object in the request body.

The Business Process Event API only supports the HTTP POST method.

<b>Note:</b> To access the Business Process Event API from an external app, you must:

-   Create an OAuth 2.0 API client on the Workday Developer Site.
-   Select the <i>Workday-Owned</i> scope to access the resources.


For more details, see [Extend Business Process Event REST API](/wcp_docs/GUID-4b87e483-baa5-4a2a-b6df-73a5d5278259-enHYPHENus.html).

## <a id="section_w4v_dbw_zhb"></a>Example: Create a Charity Event

<b>API Endpoint:</b>

https://api.workday.com/apps/charitableDonations_abcdef/v1/createCharityEvents

<b>HTTP Method:</b>

-   POST


<b>Headers:</b>

-   Content-Type : application/json.
-   Authorization : Bearer + token (your app uses this token to make all access requests for the API Gateway).


<b>Request Body:</b>

```
{
   "description": "Establish a relationship manager.",
   "businessProcessTarget": {
       "id": "151e735eaa108179a75f70768306d002"
   }
}
```

The `id` is the Workday ID of the target business object.

<b>cURL Request:</b>

```
curl --request POST \
 --url https://api.workday.com/apps/charitableDonations_abcdef/v1/createCharityEvents \
 --header 'authorization: Bearer [token] ' \
 --header 'content-type: application/json' \
 --data '{
  "description": "Establish a relationship manager.",
  "businessProcessTarget": {
      "id": "151e735eaa108179a75f70768306d002"
  }
}'
```

## <a id="section_pql_qvf_ltb"></a>Bulk Operations

The Business Process Event API doesn't support bulk operations.

## <a id="section_dzl_q1z_gmb"></a>Enable a Business Process for Async Orchestrations

You can enable a business process for Async orchestrations by adding this code to the business process in App Builder:

`"useForOrchestrate": true`

<b>Note:</b> Use the `"useForOrchestrate": true` attribute when you want the orchestration to pause when the business process starts, and to resume when the Orchestration <i>Service</i> step configured on the business process definition resumes the orchestration.

Example: `.businessprocess` file with this attribute included:

```
{
  "id": 1,
  "name": "CreateCharity",
  "label": "Create Charity",
  "description": "Create a Charity to accept Charitable Donations for.",
  "targetBusinessObject": "Charity",
  "allowsCancel": false,
  "useForOrchestrate": true,
  "approvalStep": {
    "actions": [
      "APPROVE",
      "DENY"
    ],
    "pageRoute": "/charityEvent/{eventId}"
  },
  "details": {
    "pageRoute": "/charityEvent/{eventId}"
  }
}
```

### Related Information

[Reference: Workday Extend API Gateways and Authorization Base URLs](/wcp_docs/dlh1653340161856.html)