Skip to content

Detailed Callback methods #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anastasiaberyoza merged 2 commits into from
Jul 24, 2025
Merged

Detailed Callback methods #776

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92d86df
Detailed Callback methods
anastasiaberyoza Jul 24, 2025
033982d
Added whitespace
anastasiaberyoza Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions content/guides/applications/web-app-integrations/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You will be able to deactivate them and change the implementation to a new one.
## Create an OAuth 2.0 Application

Navigate to the [Developer Console][devconsole] and create a [Platform App][ca]
that leverages [OAuth 2.0 authentication][custom-oauth2].
that leverages [OAuth 2.0 authentication][custom-oauth2].

## Create a New Integration

Expand Down Expand Up @@ -68,29 +68,28 @@ To configure the integration, follow the guidance below for each value.
The **Callback Parameters** section configures the parameters that Box sends to
the callback URL when a user accepts a confirmation prompt. If this setting is
not configured, Box does not send any parameters to the callback URL.
To add a parameter, select the **Method**,
To add a parameter, select the **Method** (GET or POST),
specify the **Parameter name** and add a **Parameter value**.
Available methods are **Get** and **Post**.

<message type='warning'>
The **File** method is no longer supported. If you already used this method,
you cannot edit its values. You can change the **File** method to **Get**
or **Post**, but you can't undo this action.
you cannot edit its values. You can change the **File** method to **GET**
or **POST**, but you can't undo this action.
</message>

For example: **Get - `userid` - `#user_id#`**.
For example: **GET - `userid` - `#user_id#`**.

The following parameter values are available.

| Parameter |Description |
|-----------------------|-------------------------------------------------------------------------------|
| `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.|
| `user_name` | The full name or email address of the Box user. Not all Box users specify their names at all times. |
| `file_id` | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
| `file_name` | The name of the file. |
| `file_extension` | The extension of the file. |
| `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.
| `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`|
| Parameter | Method | Description |
|-----------|--------|-------------|
| `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.|
| `user_name` | POST | The full name or email address of the Box user. Not all Box users specify their names at all times. |
| `file_id` | GET, POST | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
| `file_name` | POST | The name of the file. |
| `file_extension` | GET, POST | The extension of the file. |
| `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.
| `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`|

### Integration Status

Expand Down
Loading