Event When Creating a Recurring Deal Template onCrmDealRecurringAdd
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can subscribe: any user
The event ONCRMDEALRECURRINGADD will trigger when a recurring deal template is created manually or via the method crm.deal.recurring.add.
Bitrix24 creates the template deal as a regular deal: when a template is created in the interface, or when a regular deal is copied by the crm.deal.recurring.add method. Therefore, the onCrmDealAdd event with the ID of the template deal arrives before onCrmDealRecurringAdd — this value matches RECURRING_DEAL_ID. If you pass a template deal with IS_RECURRING = Y to crm.deal.recurring.add, no new deal is created and onCrmDealAdd does not arrive.
Events will not be sent to the application until the installation is complete. Check the application installation
What the Handler Receives
Data is transmitted as a POST request
{
"event": "ONCRMDEALRECURRINGADD",
"event_handler_id": "677",
"data": {
"FIELDS": {
"ID": "11",
"RECURRING_DEAL_ID": "6797"
}
},
"ts": "1741091781",
"auth": {
"access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
"expires_in": "3600",
"scope": "crm",
"domain": "some-domain.bitrix24.com",
"server_endpoint": "https://oauth.bitrix.info/rest/",
"status": "L",
"client_endpoint": "https://some-domain.bitrix24.com/rest/",
"member_id": "a223c6b3710f85df22e9377d6c4f7553",
"application_token": "51856fefc120afa4b628cc82d3935cce"
}
}
|
parameter |
Description |
|
event |
Symbolic code of the event. In this case — |
|
event_handler_id |
Identifier of the event handler |
|
data |
Object containing information about the created recurrence settings. Contains a single key |
|
data.FIELDS |
Object with the identifiers of the created recurrence settings and the template deal. The structure is described below |
|
ts |
Date and time of the event sent from the event queue |
|
auth |
Object containing authorization parameters and information about the account where the event occurred. The structure is described below |
Parameter FIELDS
|
parameter |
Description |
|
ID |
Identifier of the recurrence settings. Pass it to the |
|
RECURRING_DEAL_ID |
Identifier of the template deal whose field values are copied. Matches the |
Parameter auth
Required parameters are marked with *
|
Name |
Description |
|
access_token |
Authorization token OAuth 2.0 |
|
expires_in |
Time in seconds until the token expires |
|
scope* |
Scope under which the event occurred |
|
domain* |
Address of Bitrix24 where the event occurred |
|
server_endpoint* |
Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens |
|
status* |
Status of the application that subscribed to this event:
|
|
client_endpoint* |
Common path for REST API method calls for Bitrix24 where the event occurred |
|
member_id* |
Identifier of Bitrix24 where the event occurred |
|
refresh_token |
Token for extending authorization OAuth 2.0 |
|
application_token* |
Token for secure event handling |
Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.
It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.
Continue Learning
- Events: Overview of Methods and Events
- Register a New Event Handler event.bind
- Event on Changing Recurrence Settings of a Recurring Deal onCrmDealRecurringUpdate
- Event on Deleting a Recurring Deal Template onCrmDealRecurringDelete
- Event When Creating a Deal from a Recurring Deal Template onCrmDealRecurringExpose