Skip to main content
All CollectionsIntegrations & APIRequests API
Requests API: Custom Properties
Requests API: Custom Properties
Updated over 2 years ago

Reporting and Using Custom Properties

Stella has used standardized fields within our integrations. Now if there’s information within your CRM that would be helpful to have within Stella, you can now send through our API! This can be used for reporting, filtering, custom marketing links, and potentially other scenarios within your survey and Stella. If you’d like to learn more please contact your Client Success Manager to discuss.

How it works

Update Your Integration

If you choose to send a custom property, you will need to update your integration to send the information on a per-survey basis.

Send requests to the Stella Connect endpoint at https://api.stellaconnect.net/v1/requests using the following updated schema. Updated fields highlighted in bold are some examples but any value can be sent.

{ "customer": {   "name": "Jane",   "email": 
"janecustomer@example.com" }, "employee": {   "custom_id": "522743",
  "email": "paulagent@blancapeak.com" }, "channel": "chat",
"ext_interaction_id": "5000f00001ClBXZ", "external_url":
"https://na63.salesforce.com/5000f00001ClBXZ", "do_not_send": true,
"tags": [   "product-defect",   "return",   "vip" ], "brand":
"blancakids", "language": "en", "country": "us", "custom_properties":
{   "customer_reward_number": "12345",   "branch_id": "Ithica"
  "product_type": "clearance"   "your_custom_property": "Your Custom
Value" }}

Using one of Stella’s partner Integrations? Reach out to your Customer Success Manager to learn more about what is possible.

Refer to the full Stella API documentation here: https://apidocs.stellaconnect.net/#intro

Using Your Custom Property

Once a custom property has been sent over, it will automatically be included as a new column in your export and as an available field within data return. You can also choose to have it enabled for filtering within Stella on the Stream as well as on the Company Dashboards and all of the Trends Reports.

mceclip0.png
mceclip1.png

It can also be enabled to just display on the Stream Footer if needed.

mceclip2.png

Reach out to your Client Success Manager to have either of these enabled for each property.

Once set up properly, you're ready to start using custom properties!

Did this answer your question?