Add a New Action bizproc.activity.add

Scope: bizproc

Who can execute the method: administrator

Adds a new action for use in workflows.

The method works only in the context of the application.

Each document generates its own set of field types. For example, in CRM, there is a field of type Address UF:address. To use this field type in your actions, specify the CRM document type in DOCUMENT_TYPE and describe the field properties in PROPERTIES.

Method Parameters

Required parameters are marked with *

Name
type

Description

CODE*
string

Internal identifier of the action. It must be unique within the application.

Allowed characters are a-z, A-Z, 0-9, dot, hyphen, and underscore _

HANDLER*
string

URL to which the action will send data via the Bitrix24 queue server.

The link must have the same domain where the application is installed

AUTH_USER_ID
integer

Identifier of the user whose token will be passed to the application

USE_SUBSCRIPTION
boolean

Should the action wait for a response from the application? Possible values:

  • Y — yes
  • N — no

NAME*
string | object

Name of the action.

It can be a string or an associative array of localized strings like:

'NAME': {
            'de': 'Aktionsname',
            'en': 'action name',
            ...
        },

DESCRIPTION
string | object

Description of the action.

It can be a string or an associative array of localized strings like:

'DESCRIPTION': {
            'de': 'Aktionsbeschreibung',
            'en': 'action description',
            ...
        },

PROPERTIES
object

An object with action parameters. Contains objects, each describing a parameter of the action.

The system name of the parameter must start with a letter and can contain characters a-z, A-Z, 0-9, and underscore _

RETURN_PROPERTIES
object

An object with additional results of the action. Contains objects, each describing a parameter of the action.

This parameter controls whether the action can wait for a response from the application and work with the data that will come in the response.

The system name of the parameter must start with a letter and can contain characters a-z, A-Z, 0-9, and underscore _

DOCUMENT_TYPE
array

Document type that will determine the data types for the PROPERTIES and RETURN_PROPERTIES parameters. Consists of three string-type elements:

  • module identifier
  • object identifier
  • document type

Possible value options:

  • CRM Module
    ['crm', 'CCrmDocumentLead', 'LEAD'] — leads
    ['crm', 'CCrmDocumentContact', 'CONTACT'] — contacts
    ['crm', 'CCrmDocumentCompany', 'COMPANY'] — companies
    ['crm', 'CCrmDocumentDeal', 'DEAL'] — deals
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE'] — estimates
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE'] — invoices
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_XXX'] — SPAs, where XXX is the identifier of the SPA

  • Lists Module
    ['lists', 'BizprocDocument', 'iblock_XXX'] — processes in the news feed, where XXX is the identifier of the information block
    ['lists', 'Bitrix\Lists\BizprocDocumentLists', 'iblock_XXX'] — lists in groups, where XXX is the identifier of the information block

  • Drive Module
    ['disk', 'Bitrix\Disk\BizProcDocument', 'STORAGE_XXX'], where XXX is the storage identifier

FILTER
object

An object with rules to limit the action by document type and edition.

It can contain keys:

  • INCLUDE — an array of rules where the action will be displayed
  • EXCLUDE — an array of rules where the action will be hidden

Each rule in the array can be a string or an array of document types in full or partial form.

To limit the action by Bitrix24 edition, specify:

  • b24 — for cloud
  • box — for on-premise

Examples:

  1. Exclude the action for on-premise Bitrix24 
    FILTER: {
            EXCLUDE: [ 'box' ]
        }
  2. Display the action only for the Lists module 
    FILTER: {
            INCLUDE: [
                ['lists']
            ]
        }
  3. Display the action only for the Lists module and deals from CRM 
    FILTER: {
            INCLUDE: [
                ['lists'],
                ['crm', 'CCrmDocumentDeal']
            ]
        }

USE_PLACEMENT
boolean

Allows opening additional settings for the action in the application slider. Possible values:

  • Y — yes
  • N — no

PLACEMENT_HANDLER*
string

URL of the placement handler on the application side. Required if USE_PLACEMENT = 'Y'

PROPERTY Object

Name
type

Description

Name
string | object

Name of the parameter

Description
string | object

Description of the parameter

Type
string

Type of the parameter. Basic values:

  • bool — yes or no
  • date — date
  • datetime — date and time
  • double — number
  • int — integer
  • select — list
  • string — string
  • text — text
  • user — user

Options
array

Array of values for the parameter of type list 'TYPE': select' like:

[
            'value1': 'title1',
            'value2': 'title2',
            'value3': 'title3',
            'value4': 'title4'
        ]

Required
boolean

Whether the parameter is required. Possible values:

  • Y — yes
  • N — no

Multiple
boolean

Whether the parameter can have multiple values. Possible values:

  • Y — yes
  • N — no

Default
any

Default value of the parameter

Example Objects

// example for select type
        'docType': {
            'Name': {
                'de': 'Dokumenttyp',
                'en': 'Document type'
            },
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'PDF',
            'Type': 'select',
            'Options': {
                'pdf': 'PDF',
                'docx': 'DOCX'
            }
        }
        
        // example for bool type
        'saveDoc': {
            'Name': {
                'de': 'Dokument speichern',
                'en': 'Save document'
            },
            'Description': {
                'de': 'Ordnungsnummer zuweisen',
                'en': 'Assign a sequential number'
            },
            'Type': 'bool',
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'Y'
        }
        
        // example for string type
        'Parameters': {
            'Name': {
                'de': 'Vorlagenparameter',
                'en': 'Template\'s parameters'
            },
            'Description': {
                'de': 'ParamID={=ParamValue}',
                'en': 'ParamID={=ParamValue}'
            },
            'Type': 'string',
            'Required': 'N',
            'Multiple': 'Y'
        }

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"md5_action","HANDLER":"https://your_domain/ping.php","AUTH_USER_ID":1,"USE_SUBSCRIPTION":"Y","NAME":{"de":"MD5 Generator","en":"MD5 generator"},"DESCRIPTION":{"de":"Die Aktion gibt den MD5-Hash des Eingabeparameters zurück","en":"Activity returns MD5 hash of input parameter"},"PROPERTIES":{"inputString":{"Name":{"de":"Eingabestring","en":"Input string"},"Description":{"de":"Geben Sie den String ein, den Sie hashen möchten","en":"Input string for hashing"},"Type":"string","Required":"Y","Multiple":"N","Default":"{=Document:NAME}"}},"RETURN_PROPERTIES":{"outputString":{"Name":{"de":"MD5","en":"MD5"},"Type":"string","Multiple":"N","Default":null}},"DOCUMENT_TYPE":["lists","BizprocDocument","iblock_164"],"FILTER":{"INCLUDE":[["lists"]]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.activity.add
        
try
        {
        	const response = await $b24.callMethod(
        		'bizproc.activity.add',
        		{
        			'CODE': 'md5_action',
        			'HANDLER': 'https://your_domain/ping.php',
        			'AUTH_USER_ID': 1,
        			'USE_SUBSCRIPTION': 'Y',
        			'NAME': {
        				'de': 'MD5 Generator',
        				'en': 'MD5 generator'
        			},
        			'DESCRIPTION': {
        				'de': 'Die Aktion gibt den MD5-Hash des Eingabeparameters zurück',
        				'en': 'Activity returns MD5 hash of input parameter'
        			},
        			'PROPERTIES': {
        				'inputString': {
        					'Name': {
        						'de': 'Eingabestring',
        						'en': 'Input string'
        					},
        					'Description': {
        						'de': 'Geben Sie den String ein, den Sie hashen möchten',
        						'en': 'Input string for hashing'
        					},
        					'Type': 'string',
        					'Required': 'Y',
        					'Multiple': 'N',
        					'Default': '{=Document:NAME}'
        				}
        			},
        			'RETURN_PROPERTIES': {
        				'outputString': {
        					'Name': {
        						'de': 'MD5',
        						'en': 'MD5'
        					},
        					'Type': 'string',
        					'Multiple': 'N',
        					'Default': null
        				}
        			},
        			'DOCUMENT_TYPE': ['lists', 'BizprocDocument', 'iblock_164'],
        			'FILTER': {
        				INCLUDE: [
        					['lists']
        				]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	alert("Success: " + result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.activity.add',
                    [
                        'CODE'            => 'md5_action',
                        'HANDLER'         => 'https://your_domain/ping.php',
                        'AUTH_USER_ID'    => 1,
                        'USE_SUBSCRIPTION' => 'Y',
                        'NAME'            => [
                            'de' => 'MD5 Generator',
                            'en' => 'MD5 generator'
                        ],
                        'DESCRIPTION'     => [
                            'de' => 'Die Aktion gibt den MD5-Hash des Eingabeparameters zurück',
                            'en' => 'Activity returns MD5 hash of input parameter'
                        ],
                        'PROPERTIES'      => [
                            'inputString' => [
                                'Name'        => [
                                    'de' => 'Eingabestring',
                                    'en' => 'Input string'
                                ],
                                'Description' => [
                                    'de' => 'Geben Sie den String ein, den Sie hashen möchten',
                                    'en' => 'Input string for hashing'
                                ],
                                'Type'        => 'string',
                                'Required'    => 'Y',
                                'Multiple'    => 'N',
                                'Default'     => '{=Document:NAME}'
                            ]
                        ],
                        'RETURN_PROPERTIES' => [
                            'outputString' => [
                                'Name'     => [
                                    'de' => 'MD5',
                                    'en' => 'MD5'
                                ],
                                'Type'     => 'string',
                                'Multiple' => 'N',
                                'Default'  => null
                            ]
                        ],
                        'DOCUMENT_TYPE'    => ['lists', 'BizprocDocument', 'iblock_164'],
                        'FILTER'           => [
                            'INCLUDE' => [
                                ['lists']
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'bizproc.activity.add',
            {
                'CODE': 'md5_action',
                'HANDLER': 'https://your_domain/ping.php',
                'AUTH_USER_ID': 1,
                'USE_SUBSCRIPTION': 'Y',
                'NAME': {
                    'de': 'MD5 Generator',
                    'en': 'MD5 generator'
                },
                'DESCRIPTION': {
                    'de': 'Die Aktion gibt den MD5-Hash des Eingabeparameters zurück',
                    'en': 'Activity returns MD5 hash of input parameter'
                },
                'PROPERTIES': {
                    'inputString': {
                        'Name': {
                            'de': 'Eingabestring',
                            'en': 'Input string'
                        },
                        'Description': {
                            'de': 'Geben Sie den String ein, den Sie hashen möchten',
                            'en': 'Input string for hashing'
                        },
                        'Type': 'string',
                        'Required': 'Y',
                        'Multiple': 'N',
                        'Default': '{=Document:NAME}'
                    }
                },
                'RETURN_PROPERTIES': {
                    'outputString': {
                        'Name': {
                            'de': 'MD5',
                            'en': 'MD5'
                        },
                        'Type': 'string',
                        'Multiple': 'N',
                        'Default': null
                    }
                },
                'DOCUMENT_TYPE': ['lists', 'BizprocDocument', 'iblock_164'],
                'FILTER': {
                    INCLUDE: [
                        ['lists']
                    ]
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.activity.add',
            [
                'CODE' => 'md5_action',
                'HANDLER' => 'https://your_domain/ping.php',
                'AUTH_USER_ID' => 1,
                'USE_SUBSCRIPTION' => 'Y',
                'NAME' => [
                    'de' => 'MD5 Generator',
                    'en' => 'MD5 generator'
                ],
                'DESCRIPTION' => [
                    'de' => 'Die Aktion gibt den MD5-Hash des Eingabeparameters zurück',
                    'en' => 'Activity returns MD5 hash of input parameter'
                ],
                'PROPERTIES' => [
                    'inputString' => [
                        'Name' => [
                            'de' => 'Eingabestring',
                            'en' => 'Input string'
                        ],
                        'Description' => [
                            'de' => 'Geben Sie den String ein, den Sie hashen möchten',
                            'en' => 'Input string for hashing'
                        ],
                        'Type' => 'string',
                        'Required' => 'Y',
                        'Multiple' => 'N',
                        'Default' => '{=Document:NAME}'
                    ]
                ],
                'RETURN_PROPERTIES' => [
                    'outputString' => [
                        'Name' => [
                            'de' => 'MD5',
                            'en' => 'MD5'
                        ],
                        'Type' => 'string',
                        'Multiple' => 'N',
                        'Default' => null
                    ]
                ],
                'DOCUMENT_TYPE' => ['lists', 'BizprocDocument', 'iblock_164'],
                'FILTER' => [
                    'INCLUDE' => [
                        ['lists']
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1738148752.692647,
                "finish": 1738148752.749058,
                "duration": 0.056411027908325195,
                "processing": 0.018677949905395508,
                "date_start": "2025-01-29T14:05:52+01:00",
                "date_finish": "2025-01-29T14:05:52+01:00",
                "operating_reset_at": 1738149352,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

Returns true if the action was successfully added

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
            "error_description": "Empty activity code!"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Error Message

Description

ACCESS_DENIED

Application context required

Application context is required

ACCESS_DENIED

Access denied!

Method was not executed by an administrator

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty data!

Required fields are missing

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity code!

Action code is not specified

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity code!

Invalid action code

ERROR_UNSUPPORTED_PROTOCOL

Unsupported handler protocol

Invalid handler protocol http, https

ERROR_WRONG_HANDLER_URL

Wrong handler URL

Invalid handler URL

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity NAME!

Action name is not specified

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong properties array!

Incorrectly filled PROPERTIES or RETURN_PROPERTIES parameters

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong property key !

Invalid property identifier

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty property NAME !

Property name is not specified

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity FILTER!

Invalid filter

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity DOCUMENT_TYPE!

Invalid DOCUMENT_TYPE

ERROR_ACTIVITY_ALREADY_INSTALLED

Activity or Robot already installed!

An action with this code is already installed

ERROR_ACTIVITY_ADD_FAILURE

Activity or Robot already added!

The action has already been added

ERROR_ACTIVITY_ADD_FAILURE

Activity save error!

Failed to save the action, system error

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Overview of Methods
Next
Update Action