Skip to content

Commit 4d9c321

Browse files
Modified callback parameters description
1 parent b764376 commit 4d9c321

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

  • content/guides/applications/web-app-integrations

content/guides/applications/web-app-integrations/configure.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,8 @@ To configure the integration, follow the guidance below for each value.
6868
The **Callback Parameters** section configures the parameters that Box sends to
6969
the callback URL when a user accepts a confirmation prompt. If this setting is
7070
not configured, Box does not send any parameters to the callback URL.
71-
To add a parameter, select the **Method**,
71+
To add a parameter, select the **Method** (GET or POST),
7272
specify the **Parameter name** and add a **Parameter value**.
73-
Available methods are **Get** and **Post**.
7473

7574
<message type='warning'>
7675
The **File** method is no longer supported. If you already used this method,
@@ -82,15 +81,15 @@ For example: **Get - `userid` - `#user_id#`**.
8281

8382
The following parameter values are available.
8483

85-
| Parameter |Description |
86-
|-----------------------|-------------------------------------------------------------------------------|
87-
| `user_id` | The Box [user ID][uid]. This information is used in Popup Integrations in which user authentication is required to complete an action. You can store the Box ID in your application to enable subsequent authentication requests from the integration.|
88-
| `user_name` | The full name or email address of the Box user. Not all Box users specify their names at all times. |
89-
| `file_id` | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
90-
| `file_name` | The name of the file. |
91-
| `file_extension` | The extension of the file. |
92-
| `auth_code` | The OAuth 2.0 [authorization code][code], which is generated by Box upon successful authentication. Your application must then supply this authorization code to Box in exchange for an OAuth 2.0 Access Token. An authorization header containing a valid Access Token must be included in every Box API request.
93-
| `redirect_to_box_url` | In Popup Integrations, the URL to which requests are sent by the confirmation prompt. Use this URL to redirect users to the All Files page. This parameter closes the popup panel and refreshes the All Files page to reflect any changes performed by the integration. If you do not want to add this parameter to your application, you can specify the entire URL. **Success**: `#redirect_to_box_url#&status=success&message=Your%20action%20was%20successful%2E`. **Failure**: `#redirect_to_box_url#&status=failure&message=Your%20action%20was%20unsuccessful%2E`|
84+
| Parameter | Method | Description |
85+
|-----------|--------|-------------|
86+
| `user_id` | GET, POST | The Box [user ID][uid]. This information is used in Popup Integrations in which user authentication is required to complete an action. You can store the Box ID in your application to enable subsequent authentication requests from the integration.|
87+
| `user_name` | POST | The full name or email address of the Box user. Not all Box users specify their names at all times. |
88+
| `file_id` | GET, POST | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
89+
| `file_name` | POST | The name of the file. |
90+
| `file_extension` | GET, POST | The extension of the file. |
91+
| `auth_code` | GET, POST | The OAuth 2.0 [authorization code][code], which is generated by Box upon successful authentication. Your application must then supply this authorization code to Box in exchange for an OAuth 2.0 Access Token. An authorization header containing a valid Access Token must be included in every Box API request.
92+
| `redirect_to_box_url` | GET, POST | In Popup Integrations, the URL to which requests are sent by the confirmation prompt. Use this URL to redirect users to the All Files page. This parameter closes the popup panel and refreshes the All Files page to reflect any changes performed by the integration. If you do not want to add this parameter to your application, you can specify the entire URL. **Success**: `#redirect_to_box_url#&status=success&message=Your%20action%20was%20successful%2E`. **Failure**: `#redirect_to_box_url#&status=failure&message=Your%20action%20was%20unsuccessful%2E`|
9493

9594
### Integration Status
9695

0 commit comments

Comments
 (0)