Get all trigger types for automation blocks
Headers
-
Content-Type string
-
Accept string
GET /api/v1/automation-blocks/triggers
curl \
-X GET https://api.plannrcrm.com/api/v1/automation-blocks/triggers \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "Run at a specific date",
"type": "client.created",
"returns": {
"client": [
"title",
"value",
"next_review_date",
"previous_review_date",
"anniversary_review_date",
"checked_sanctions_at",
"lead_source",
"first_contact_date",
"gender",
"date_of_birth",
"target_retirement_age",
"smoker_status",
"residential_status",
"country_of_residence",
"marital_status",
"is_prospect",
"is_vulnerable",
"is_uk_resident",
"is_uk_domicile",
"expected_retirement_age",
"state_retirement_age",
"third_party_offered",
"current_state_of_health",
"long_term_care_needed",
"has_will",
"will_last_reviewed",
"has_power_of_attorney",
"units_of_alcohol_weekly",
"has_gifted_family",
"is_anticipating_inheritance",
"is_in_receipt_of_your_state_pension",
"has_obtained_a_forecast",
"date_of_forecast",
"years_of_national_insurance_contributions",
"date_of_marriage",
"is_deceased",
"deceased_at"
]
},
"description": "Trigger an automation on a specific date",
"configParams": {
"client": [
"title",
"value",
"next_review_date",
"previous_review_date",
"anniversary_review_date",
"checked_sanctions_at",
"lead_source",
"first_contact_date",
"gender",
"date_of_birth",
"target_retirement_age",
"smoker_status",
"residential_status",
"country_of_residence",
"marital_status",
"is_prospect",
"is_vulnerable",
"is_uk_resident",
"is_uk_domicile",
"expected_retirement_age",
"state_retirement_age",
"third_party_offered",
"current_state_of_health",
"long_term_care_needed",
"has_will",
"will_last_reviewed",
"has_power_of_attorney",
"units_of_alcohol_weekly",
"has_gifted_family",
"is_anticipating_inheritance",
"is_in_receipt_of_your_state_pension",
"has_obtained_a_forecast",
"date_of_forecast",
"years_of_national_insurance_contributions",
"date_of_marriage",
"is_deceased",
"deceased_at"
]
}
}
]
}