Alarm.com
Provision and manage the customer's Alarm.com interactive-services account. All actions
run against POST /customers/{id}/... and call the same integration engine as the
SecurityTrax Alarm.com tab; the customer's identity data (name, address, email, phone,
central-station numbers) always comes from the customer record, so keep it accurate
before provisioning.
Gated by the Alarm.com permission at the customer's location — modify for the
provisioning actions, view for adc_packages.
Call order
- Point the customer at the enabled Alarm.com provider if it isn't already:
PATCH /customers/{id}withinteractive_services_provider_id(settable until linked). adc_packages— pick the service package (and add-ons) from the live dealer catalog. Filter withaccount_type(Videolists the camera-only packages). Package +add_on_featuresare how camera-only vs security + video is expressed.adc_create_customerfor a live account, oradc_create_commitmentwhen the panel isn't installed yet.- If you created a commitment:
adc_activate_commitmentonce the modem + panel are in. - Later plan changes:
adc_change_service_plan.
Credentials and the duplicate guard
Both create actions return the customer's Alarm.com app credentials once, in
meta.data.credentials — deliver them to the customer immediately and do not store them.
A create on an already-linked customer is a hard 409 already_provisioned with no force
override: a duplicate provision would open a second real Alarm.com account and silently
overwrite the link. Unlink in SecurityTrax first if re-provisioning is intended.
Action reference
Provision a full Alarm.com account for this customer
POST /{profile}/user/v4/customers/{id}/adc_create_customer
| Field | Required | Type | Description |
|---|---|---|---|
package_id |
Yes | integer | The ADC service package (discover with adc_packages). Package + add-ons express camera-only vs security + video. |
modem_serial_number |
Yes | string | 10- or 15-digit modem/IMEI serial. |
panel_type |
Yes | string | The panel model key (the portal's panel dropdown values). |
central_station_forwarding_option |
Yes | string | When ADC forwards signals to the central station. One of: Never, Always, OnlyIfPhoneFails. |
property_type |
Yes | string | The premises type. One of: SingleFamilyHouse, Townhouse, Condo, Business. |
install_type |
Yes | string | Who installs. One of: ProfessionalInstall, SelfInstall. |
add_on_features |
No | object | Flat {feature_name: true|false|quantity} map of ADC add-ons (video, doorbell cameras, …). |
phone_line_present |
No | boolean | Defaults false. |
ignore_low_coverage_errors |
No | boolean | Defaults false. |
desired_login_name |
No | string | Requested ADC login; ADC may adjust it. |
branch_id |
No | integer | ADC sub-dealer branch. |
template_id |
No | integer | ADC package template id. |
installer_code |
No | string | Installer code. |
communication_pathway |
No | string | Panel communication pathway. One of: NonDualpathPanel, CellOnly, BroadbandOnly, CellAndBroadband. |
panel_setting_template_id |
No | integer | Panel-setting template. |
builder_program_id |
No | integer | ADC builder program. |
customer_notifications |
No | boolean | Enable ADC customer notifications. |
Reserve a pre-provisioned Alarm.com account (commitment) for this customer
POST /{profile}/user/v4/customers/{id}/adc_create_commitment
| Field | Required | Type | Description |
|---|---|---|---|
package_id |
Yes | integer | The ADC service package (discover with adc_packages). Package + add-ons express camera-only vs security + video. |
modem_serial_number |
No | string | 10- or 15-digit modem/IMEI serial — optional for a commitment; supplied at activation otherwise. |
panel_type |
Yes | string | The panel model key (the portal's panel dropdown values). |
central_station_forwarding_option |
Yes | string | When ADC forwards signals to the central station. One of: Never, Always, OnlyIfPhoneFails. |
property_type |
Yes | string | The premises type. One of: SingleFamilyHouse, Townhouse, Condo, Business. |
install_type |
Yes | string | Who installs. One of: ProfessionalInstall, SelfInstall. |
add_on_features |
No | object | Flat {feature_name: true|false|quantity} map of ADC add-ons (video, doorbell cameras, …). |
phone_line_present |
No | boolean | Defaults false. |
ignore_low_coverage_errors |
No | boolean | Defaults false. |
desired_login_name |
No | string | Requested ADC login; ADC may adjust it. |
branch_id |
No | integer | ADC sub-dealer branch. |
template_id |
No | integer | ADC package template id. |
installer_code |
No | string | Installer code. |
communication_pathway |
No | string | Panel communication pathway. One of: NonDualpathPanel, CellOnly, BroadbandOnly, CellAndBroadband. |
panel_setting_template_id |
No | integer | Panel-setting template. |
builder_program_id |
No | integer | ADC builder program. |
customer_notifications |
No | boolean | Enable ADC customer notifications. |
expected_network |
No | string | The expected cellular network (commitment only). One of: NotSet, Verizon, TMobile. |
Activate this customer's Alarm.com commitment into a live account
POST /{profile}/user/v4/customers/{id}/adc_activate_commitment
| Field | Required | Type | Description |
|---|---|---|---|
modem_serial_number |
Yes | string | 10- or 15-digit modem/IMEI serial now installed. |
panel_type |
Yes | string | The installed panel model key. |
ignore_low_coverage_errors |
No | boolean | Defaults false. |
Change the linked Alarm.com account's service package and add-ons
POST /{profile}/user/v4/customers/{id}/adc_change_service_plan
| Field | Required | Type | Description |
|---|---|---|---|
new_package_id |
Yes | integer | The target ADC package (discover with adc_packages). |
add_on_features |
No | object | Flat {feature_name: true|false|quantity} map of add-ons for the new plan. |
Discover the dealer's Alarm.com packages and templates (live)
POST /{profile}/user/v4/customers/{id}/adc_packages
| Field | Required | Type | Description |
|---|---|---|---|
account_type |
No | string | Filter packages by ADC account type — Video lists the camera-only packages; omit for all. One of: NotSet, Security, Video, PointCentral, EnergyAutomation, BeClose. |
Failure semantics
Pre-flight problems are 409 (wrong/missing provider or monitoring company, lead
where not permitted, already/not provisioned, no order) or 402 (integration
disabled); partner rejections are 422 carrying the partner's message; an
unreachable partner is 502 and never persists anything.
Related
- Customers — the resource these actions operate on.
- Requests and Responses — envelope, errors, pagination, and rate limits.