Help
RSS
API
Feed
Maltego
Contact
Domain > clientdocs.relayzone.com
×
Welcome!
Right click nodes and scroll the mouse to navigate the graph.
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2022-03-23
108.156.120.111
(
ClassC
)
2024-07-03
3.163.24.124
(
ClassC
)
Port 80
HTTP/1.1 301 Moved PermanentlyServer: CloudFrontDate: Wed, 03 Jul 2024 00:45:06 GMTContent-Type: text/htmlContent-Length: 167Connection: keep-aliveLocation: https://clientdocs.relayzone.com/X-Cache: Redirect from cloudfrontVia: 1.1 eb6e5a827e45274130b33c12b0d48aaa.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P2X-Amz-Cf-Id: e98pEKRlkP_cevcxSL6wqqmqGsx2iRx9k2b0wAWu6GlsRnGQRns-RQ html>head>title>301 Moved Permanently/title>/head>body>center>h1>301 Moved Permanently/h1>/center>hr>center>CloudFront/center>/body>/html>
Port 443
HTTP/1.1 200 OKContent-Type: text/htmlContent-Length: 569953Connection: keep-aliveDate: Wed, 03 Jul 2024 00:45:07 GMTx-amz-replication-status: COMPLETEDLast-Modified: Mon, 01 Jul 2024 19:12:55 GMTETag: c744d9feac7410fc5be4a6359309407ax-amz-storage-class: ONEZONE_IAx-amz-server-side-encryption: AES256x-amz-version-id: WXY085EQgeZVN_YZ8aXlLAa_1qLj.gncAccept-Ranges: bytesServer: AmazonS3X-Cache: Miss from cloudfrontVia: 1.1 44e3ef26e727fc044d711ef45aefcd72.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P2X-Amz-Cf-Id: boo62Ju3ewzCetj0NFeQqzNXQ8XBDxcor_y8bQpaaO1Vtn0mld5WqAStrict-Transport-Security: max-age63072000; includeSubDomains; preload !DOCTYPE html>html langen>head>meta charsetUTF-8>!--if IE>meta http-equivX-UA-Compatible contentIEedge>!endif-->meta nameviewport contentwidthdevice-width, initial-scale1.0>meta namegenerator contentAsciidoctor 1.5.8>meta nameauthor contentRelay Network, LLC>title>Relay Integration/title>link relstylesheet href./stylesheets/asciidoctor.client-facing.css>link relstylesheet hrefhttps://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css>/head>body classbook toc2 toc-left>div idheader>h1>Relay Integration/h1>div classdetails>span idauthor classauthor>Relay Network, LLC/span>br>span idrevnumber>version 3.20,/span>span idrevdate>Jan 2023/span>/div>div idtoc classtoc2>div idtoctitle>Table of Contents/div>ul classsectlevel0>li>a href#_relay_rest_apis>Relay REST APIs/a>ul classsectlevel1>li>a href#_overview>1. Overview/a>ul classsectlevel2>li>a href#_authentication>1.1. Authentication/a>/li>li>a href#_client_id>1.2. Client ID/a>/li>li>a href#_tolerant_reader_pattern>1.3. Tolerant Reader Pattern/a>/li>/ul>/li>li>a href#_onboarding_apis>2. Onboarding APIs/a>ul classsectlevel2>li>a href#_onboard_a_single_customer>2.1. Onboard a Single Customer/a>/li>/ul>/li>li>a href#_journey_apis>3. Journey APIs/a>ul classsectlevel2>li>a href#_trigger_journey_step>3.1. Trigger Journey Step/a>/li>li>a href#_trigger_journey_step_batch>3.2. Trigger Journey Step (batch)/a>/li>/ul>/li>li>a href#_consent_apis>4. Consent APIs/a>ul classsectlevel2>li>a href#_update_consent>4.1. Update Consent/a>/li>li>a href#_bulk_update_consent>4.2. Bulk Update Consent/a>/li>/ul>/li>li>a href#_cca_apis>5. CCA APIs/a>ul classsectlevel2>li>a href#_add_a_single_customer>5.1. Add a Single Customer/a>/li>/ul>/li>li>a href#_customer_apis>6. Customer APIs/a>ul classsectlevel2>li>a href#_get_customer>6.1. Get Customer/a>/li>li>a href#_deactivate_customer_account>6.2. Deactivate Customer Account/a>/li>li>a href#_update_the_product_group_of_a_customer>6.3. Update the Product Group of a Customer/a>/li>li>a href#_add_a_phone_number_to_a_customer>6.4. Add a phone number to a Customer/a>/li>li>a href#_remove_a_phone_number_from_a_customer>6.5. Remove a phone number from a Customer/a>/li>/ul>/li>/ul>/li>li>a href#_customer_validation_rest_api>Customer Validation REST API/a>ul classsectlevel1>li>a href#_overview_2>7. Overview/a>/li>li>a href#_implementation>8. Implementation/a>/li>/ul>/li>li>a href#_push_event_webhook>Push Event Webhook/a>ul classsectlevel1>li>a href#_overview_3>9. Overview/a>ul classsectlevel2>li>a href#_example_event_flow>9.1. Example Event Flow/a>/li>li>a href#_event_ordering>9.2. Event Ordering/a>/li>li>a href#_filtering_events>9.3. Filtering Events/a>/li>li>a href#_implementation_2>9.4. Implementation/a>/li>li>a href#_authentication_3>9.5. Authentication/a>/li>li>a href#_individual_event_processing>9.6. Individual Event Processing/a>/li>li>a href#_webhook_response>9.7. Webhook Response/a>/li>li>a href#_scaling>9.8. Scaling/a>/li>li>a href#_retry_logic>9.9. Retry Logic/a>/li>li>a href#_schedule_webhook_downtime>9.10. Schedule Webhook Downtime/a>/li>/ul>/li>li>a href#_push_events>10. Push Events/a>ul classsectlevel2>li>a href#channel_consent.update>10.1. Event: channel_consent.update/a>/li>li>a href#account.deactivate>10.2. Event: account.deactivate/a>/li>li>a href#message.action_taken>10.3. Event: message.action_taken/a>/li>li>a href#message.delivered>10.4. Event: message.delivered/a>/li>li>a href#message.undelivered>10.5. Event: message.undelivered/a>/li>li>a href#notification.attempted>10.6. Event: notification.attempted/a>/li>li>a href#notification.not_attempted>10.7. Event: notification.not_attempted/a>/li>li>a href#notification.delivered>10.8. Event: notification.delivered/a>/li>li>a href#notification.undelivered>10.9. Event: notification.undelivered/a>/li>li>a href#notification_channel.add>10.10. Event: notification_channel.add/a>/li>li>a href#notification_channel.remove>10.11. Event: notification_channel.remove/a>/li>li>a href#notification.auth_link_used>10.12. Event: notification.auth_link_used/a>/li>li>a href#powerups_data.received>10.13. Event: powerups_data.received/a>/li>li>a href#text_message.received>10.14. Event: text_message.received/a>/li>/ul>/li>/ul>/li>li>a href#_csv_file_processing>CSV File Processing/a>ul classsectlevel1>li>a href#csv-file-format>11. CSV File Format Rules/a>/li>li>a href#_csv_file_types>12. CSV File Types/a>ul classsectlevel2>li>a href#cca-csv-file-format>12.1. CCA CSV File/a>/li>li>a href#onboarding-csv-file-format>12.2. Onboarding CSV File/a>/li>li>a href#messaging-csv-file-format>12.3. Messaging CSV File/a>/li>li>a href#messaging-portal-csv-file-format>12.4. CXB Message File Upload/a>/li>li>a href#mobile-analysis-csv-file-format>12.5. Mobile Analysis CSV File/a>/li>li>a href#consent-update-csv-file-format>12.6. Consent Update CSV File/a>/li>li>a href#phone-management-csv-file-format>12.7. Phone Management CSV File/a>/li>li>a href#deactivation-csv-file-format>12.8. Deactivation CSV File/a>/li>/ul>/li>/ul>/li>li>a href#_standard_reports>Standard Reports/a>ul classsectlevel1>li>a href#_connection_events_report>13. Connection Events Report/a>/li>li>a href#_experience_events_report>14. Experience Events Report/a>/li>li>a href#_two_way_conversation_report>15. Two-way Conversation Report/a>/li>li>a href#_two_way_activity_report>16. Two-way Activity Report/a>/li>li>a href#_power_ups_report>17. Power-Ups Report/a>/li>li>a href#_inbound_sms_report>18. Inbound SMS Report/a>/li>/ul>/li>li>a href#_sftp_management_policy>SFTP Management Policy/a>ul classsectlevel1>li>a href#_sftp_user_policy>19. SFTP User Policy/a>ul classsectlevel2>li>a href#_file_drop_off_and_pick_up_process_summary>19.1. File Drop-Off and Pick-Up Process Summary/a>/li>li>a href#_power_ups_form_reporting>19.2. Power-Ups Form Reporting/a>/li>/ul>/li>li>a href#_sftp_configuration_and_usage>20. SFTP Configuration and Usage/a>ul classsectlevel2>li>a href#_overview_4>20.1. Overview/a>/li>li>a href#_client_implementation_flow>20.2. Client Implementation Flow/a>/li>li>a href#_before_you_get_started_relay_best_practices>20.3. Before You Get Started - Relay Best Practices/a>/li>li>a href#_sftp_folder_management_policy>20.4. SFTP Folder Management Policy/a>/li>li>a href#_configuration_setup_detail>20.5. Configuration Setup Detail/a>/li>li>a href#_client_will_need_to_provide>20.6. Client will need to provide/a>/li>li>a href#_frequently_asked_questions>20.7. Frequently Asked Questions/a>/li>/ul>/li>/ul>/li>li>a href#_data_models>Appendix A: Data Models/a>ul classsectlevel2>li>a href#address-model>A.1. Address Object/a>/li>li>a href#CCA-model>A.2. CCA Object/a>/li>li>a href#consent-model>A.3. Consent Object/a>/li>li>a href#contact-model>A.4. Contact Object/a>/li>li>a href#customer-model>A.5. Customer Object/a>/li>li>a href#ext-model>A.6. Ext Object/a>/li>li>a href#message-details-model>A.7. Message Details Object/a>/li>li>a href#phone-model>A.8. Phone Object/a>/li>/ul>/li>li>a href#_data_transfer_relay_to_client>Appendix B: Data Transfer - Relay to Client/a>/li>/ul>/div>/div>div idcontent>h1 id_relay_rest_apis classsect0>a classlink href#_relay_rest_apis>Relay REST APIs/a>/h1>div classsect1>h2 id_overview>a classlink href#_overview>1. Overview/a>/h2>div classsectionbody>div classsect2>h3 id_authentication>a classlink href#_authentication>1.1. Authentication/a>/h3>div classparagraph>p>All endpoints require an authentication token be passed in the code>xx-relay-api-key/code> HTTP header. Your Customer Success Manager will provide you with your unique access token./p>/div>div classparagraph>p>You must take measures to protect your API token. It should only be used for communications between your back-end services and Relay’s REST APIs. If a new token needs to be reissued, pleae contact your Customer Success Manager./p>/div>/div>div classsect2>h3 id_client_id>a classlink href#_client_id>1.2. Client ID/a>/h3>div classparagraph>p>In addition to the access token, all REST API calls require a em>client_id/em> to be passed in the request URL. A unique _client_id will be provide by your Customer Success Manager./p>/div>/div>div classsect2>h3 id_tolerant_reader_pattern>a classlink href#_tolerant_reader_pattern>1.3. Tolerant Reader Pattern/a>/h3>div classparagraph>p>a hrefhttp://servicedesignpatterns.com/WebServiceEvolution/TolerantReader classbare>http://servicedesignpatterns.com/WebServiceEvolution/TolerantReader/a>/p>/div>div classparagraph>p>When parsing HTTP response bodies it is strongly recommend to follow the em>Tolerant Reader Pattern/em>. In summary, this pattern says - Parse only the fields you are intrested in and ignore everything else including strict validation. In the future, existing APIs may be enhanced with additional (optional) properties and following the em>Tolerant Reader Pattern/em> will ensure your existing integrations do not break./p>/div>/div>/div>/div>div classsect1>h2 id_onboarding_apis>a classlink href#_onboarding_apis>2. Onboarding APIs/a>/h2>div classsectionbody>div stylepage-break-after: always;>/div>div classsect2>h3 id_onboard_a_single_customer>a classlink href#_onboard_a_single_customer>2.1. Onboard a Single Customer/a>/h3>div classparagraph>p>This API is used to onboard a code>Customer/code> to the Relay platform. If the code>Customer/code> does not exist, it will be onboarded (added) to the platform. If the code>Customer/code> already exists, it will be updated with the new information being provided./p>/div>div classparagraph>p>The onboarding API can optionally send an experience to the newly onboarded (or updated) code>Customer/code> during the same call. This is acomplished by setting the optional em>trigger_id/em> parameter in the request body./p>/div>div classparagraph>p>A single CCID is permitted to have up to 50 phone numbers associated with it. And a single phone number can be associated with up to 50 CCIDs./p>/div>div classparagraph>p>Enabling Mobile Analysis and strict onboarding configuration will add an extra code>mobile_analysis_results/code> section to the response body if the result of mobile analysis returns a phone type that is not mobile./p>/div>div classsect3>h4 id_http_request>a classlink href#_http_request>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>POST/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/onboard/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>POST/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/onboardbr>/p>/div>/div>/div>div classsect4>h5 id_url_parameters>a classlink href#_url_parameters>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers>a classlink href#_http_request_headers>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_post_request_body>a classlink href#_post_request_body>POST Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON Request Body/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>4d215f9f-596b-4bd4-9d19-645c87c8ea3a/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>launched_by/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>lb_name/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>user@company.com/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>lb_source/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>company-system/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>deactivate_previous_connections/span>span classdelimiter>"/span>/span>: span classpredefined-constant>true/span>, span classkey>span classdelimiter>"/span>span classcontent>input_parameters/span>span classdelimiter>"/span>/span>: {}, span classkey>span classdelimiter>"/span>span classcontent>asset_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>BAK-11984-007/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>secondary_account_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Roger/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Moore/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1954-01-01/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn_last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>0007/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 161/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>6105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>express|written/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>mobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>member_since/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>1999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>membership_level/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>gold/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>renewal_date/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>05/01/2019/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 1. POST Body JSON Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional experience em>trigger_id/em>. If specified, the onboarded Customer will be sent the experience associated with the specifiedi em>trigger_id/em>./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>customer/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>Object/p>/td>td classtableblock halign-left valign-top>p classtableblock>Required./p>p classtableblock>See: a href#customer-model>Customer Object/a>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>product_group_id/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Required field that specifies the product group Id that will be assigned to the Customer. A Customer can only be assigned to a single product group./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>input_parameters/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional collection of input properties. These properites will be passed to the experience identified by the em>trigger_id/em> property./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>asset_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. If specified, this asset ID will override the default asset id in the triggered experience. If em>trigger_id/em> is not set then this field will not have any effect./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>deactivate_previous_connections/p>/td>td classtableblock halign-left valign-top>p classtableblock>Boolean/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Specifies if previous connections (mobile numbers) should be removed.Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>true/td>td classhdlist2>p>If an existing Customer, deactivate all previous mobile numbers associated with the specified em>ccid/em>/p>/td>/tr>tr>td classhdlist1>false/td>td classhdlist2>p>If an existing Customer, add the new mobile number to the list of number associated with the specified em>ccid/em>./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional Client value. This value is passsed through the system and can be used by the Client to relate activites and actions back to the triggerred experience./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>launched_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional value that sepcifies the source of the onboarding event. This can be used by a Client to associate the onboarding activity with one or more of their systems./p>/td>/tr>/tbody>/table>/div>/div>div classsect3>h4 id_http_response>a classlink href#_http_response>HTTP Response/a>/h4>div classsect4>h5 id_200_ok>a classlink href#_200_ok>200 - OK/a>/h5>div classparagraph>p>A response code of 200 (OK) means the onboarding request body was valid and the request had been queued for processing./p>/div>div classparagraph>p>Currently, relay permits up to 50 phone numbers associated to one CCID andup to 50 CCIDs can be associated to a specific phone number./p>/div>div classparagraph>p>Mobile analysis result is an optional response field. If the client has mobile analysis and strict onboarding enabled, this result will be presented if any of the requested channel types are not mobile./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>Accepted/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>mobile_analysis_results/span>span classdelimiter>"/span>/span>: {span classkey>span classdelimiter>"/span>span classcontent>15555555555/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>type-not-resolved/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>15556667777/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>landline/span>span classdelimiter>"/span>/span>}}/code>/pre>/div>/div>/div>div classsect4>h5 id_400_bad_request>a classlink href#_400_bad_request>400 - Bad Request/a>/h5>div classparagraph>p>If there is an error with the request POST body, the HTTP status code will be set to 400 and the response body will contain specific details on the error./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>reason/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>reason_key/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Schema onboarding-api not met/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>error_data/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>customer.gender/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>error/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Must be one of , f, M, F, m/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Z/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>customer.date_of_birth/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>error/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>valid date/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1990/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 2. JSON Response Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>reason/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>A string containing one or more errors, each separated by a comma.It is recommened to now use the em>error_data/em> object for easier to parsing./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>reason_key/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>This field will be set to Schema onboarding-api not met/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>error_data/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>This property will contain one or more additional properties, one for each error in the POST body. The property name will be the field name (in dotted notation) that has an error. The property will contain an em>error/em> field that describes the error condition and a em>value/em> field that contains the original value that was passed in the POST body./p>/td>/tr>/tbody>/table>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 3. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The code>Customer/code> was successfully onboarded/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>/div>/div>/div>div classsect1>h2 id_journey_apis>a classlink href#_journey_apis>3. Journey APIs/a>/h2>div classsectionbody>div classparagraph>p>The Relay Journey APIs uses JSON over HTTPS to enable Client applications to programmatically trigger messages to Customers on the Relay Platform./p>/div>div stylepage-break-after: always;>/div>div stylepage-break-after: always;>/div>div classsect2>h3 id_trigger_journey_step>a classlink href#_trigger_journey_step>3.1. Trigger Journey Step/a>/h3>div classparagraph>p>This API is used to trigger a specific step in a Journey for a specific Customer./p>/div>div classsect3>h4 id_http_request_2>a classlink href#_http_request_2>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>POST/strong> https://api.relayzone.com/platform/v3/api/messaging/client/strong>:client_id/strong>/journey_trigger/strong>:trigger_id/strong>/customer/strong>:ccid/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>POST/strong> https://api.relaystaging.com/platform/v3/api/messaging/client/strong>:client_id/strong>/journey_trigger/strong>:trigger_id/strong>/customer/strong>:ccid/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_2>a classlink href#_url_parameters_2>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>/p>/td>/tr>tr>td classhdlist1>trigger_id/td>td classhdlist2>p>The unique trigger ID to be executed.br>/p>/td>/tr>/table>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>div classparagraph>p>The Relay system generates a unique trigger_id when a user creates a journey in the CX Builder. The auto-generated trigger_id looks like: code>13425ae9-7ce7-4109-beeb-b0970894bbb2/code>.br>Additionally, a client can create a more user friendly trigger_id, like: code>Delivery-Reminder-2/code>, using the CX Builder. This API will accept either option./p>/div>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_2>a classlink href#_http_request_headers_2>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_request_body>a classlink href#_request_body>Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON Request/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>asset_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>input_parameters/span>span classdelimiter>"/span>/span> : { span classkey>span classdelimiter>"/span>span classcontent>input_dob/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>5/31/1985/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>launched_by/span>span classdelimiter>"/span>/span> : { span classkey>span classdelimiter>"/span>span classcontent>lb_name/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>Frank.Smith@abccompany.com/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>lb_source/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>Operations/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 4. Journey JSON Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>If this optional property is set, the system will verify that thecode>trigger_id/code> is contained within the specified journey and if it is not an error will be returned./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>asset_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This asset id to override in the message./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>p classtableblock>String/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>input_parameters/p>/td>td classtableblock halign-left valign-top>p classtableblock>Object/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This property contains a collection of input properties for the Journey./p>p classtableblock>Input parameters are defined when the Journey is created or updated./p>p classtableblock>Each input property must be prefixed with em>input_/em>. All input property values must be of type string./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>launched_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>Object/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This object contains two properties, em>lb_name/em> and em>lb_source/em>, which a Client can use to identify their source system that made this REST API call. Both of the properties are of type code>String/code>./p>/td>/tr>/tbody>/table>/div>/div>div classsect3>h4 id_http_response_2>a classlink href#_http_response_2>HTTP Response/a>/h4>div classparagraph>p>The response will include the status of placing a message onto the Customer Feed and a status of sending a channel notification. Depending on the request it is possible to have a result for; just Feed messages, just notifications or both./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sent/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>result/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7e5189d2-3124-4d0f-9a7b-a894dbf74f5a/span>span classdelimiter>"/span>/span> } }, span classkey>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>results/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>12158372698/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ok/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ef4a71f9-3bcb-4bd2-83eb-83e051ce15a5/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sent/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>schedule/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 5. JSON Response Properties/caption>colgroup>col stylewidth: 10%;>col stylewidth: 10%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>message.status/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>This object contains the status of a code>Message/code> being added to the Customer Feed./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sent/td>td classhdlist2>p>A code>message/code> was placed onto the Customer Feed/p>/td>/tr>tr>td classhdlist1>not-sent/td>td classhdlist2>p>A code>message/code> was not placed onto the Customer Feed/p>/td>/tr>tr>td classhdlist1>error/td>td classhdlist2>p>An error occurred while trying to place a code>message/code> onto the Customer feed/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification.results/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>This object contains the status of sending the notification to each channel associated with the Customer. There will be one result entry for each channel associated with the Customer. For example, if the Customer has two phone numbers associated with the CCID, then there will be two result entries, one for each phone number./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>notification.results.channel_addr/code> field contains the result of attempting to send a notification on the specific channel./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>notification.results.channel_type/code> identifies the type of channel.Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>The code>channel_addr/code> is a mobile phone number and the notification will be sent via SMS/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>results.status/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>notification.results.status/code> field contains the result of attempting to send a notification on the specific channel./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>ok/td>td classhdlist2>p>A notification was successfully sent/p>/td>/tr>tr>td classhdlist1>error-sms/td>td classhdlist2>p>An error occurred while attempting to send and SMS notification/p>/td>/tr>tr>td classhdlist1>no-consent/td>td classhdlist2>p>The mobile number does not have consent to send a notification/p>/td>/tr>tr>td classhdlist1>channel-deactivated/td>td classhdlist2>p>The channel has been deactivated and can no longer received notifications./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification.status/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>This field is being deprecated and should no longer be used. Use the code>notification.results.status/code> property instead./td>/tr>/table>/div>/div>/td>/tr>/tbody>/table>div classsect4>h5 id_400_bad_request_2>a classlink href#_400_bad_request_2>400 - Bad Request/a>/h5>div classparagraph>p>If there is an error with the request POST body, the HTTP status code will be set to 400 and the response body will contain specific details on the error.Note that the structure of the error response JSON may differ depending on the nature of the error. See example responses for more detail./p>/div>div classlistingblock>div classtitle>Example JSON Response with error string/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>error/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Duplicate message suppression is active/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 6. JSON Response Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>error/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>A string containing a textual description of the error./p>/td>/tr>/tbody>/table>div classlistingblock>div classtitle>Example JSON Response with error array/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>error/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>relay-customer/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>missing-fields/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>data/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>input_customer_name1/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 7. JSON Response Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>error/p>/td>td classtableblock halign-left valign-top>p classtableblock>object/p>/td>td classtableblock halign-left valign-top>p classtableblock>This property will contain information about the error./p>/td>/tr>/tbody>/table>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 8. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>/div>/div>div classsect2>h3 id_trigger_journey_step_batch>a classlink href#_trigger_journey_step_batch>3.2. Trigger Journey Step (batch)/a>/h3>div classparagraph>p>This API is used to batch up a list of Journey Trigger requests.Each request in the list can be for a different journey, trigger, customer combination./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>This API limits the batch size to 100. If more than 100 requests are submitted, the APIcall will return with a em>400 BAD REQUEST/em> error./td>/tr>/table>/div>div classsect3>h4 id_http_request_3>a classlink href#_http_request_3>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>POST/strong> https://api.relayzone.com/platform/v3/api/messaging/client/strong>:client_id/strong>/journey_trigger/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>POST/strong> https://api.relaystaging.com/platform/v3/api/messaging/client/strong>:client_id/strong>/journey_triggerbr>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_3>a classlink href#_url_parameters_3>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_3>a classlink href#_http_request_headers_3>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_request_body_2>a classlink href#_request_body_2>Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON Request/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>batch/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7028cb2e-d62d-4d5f-a285-91d25781ea86/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>CRD-98027-004/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>asset_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>input_parameters/span>span classdelimiter>"/span>/span>: { } }, { span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>d1f4260a-ff7c-44d8-a2e4-0dc30bc7a2cd/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>BAK-11984-007/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>asset_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>input_parameters/span>span classdelimiter>"/span>/span>: { } } , span classkey>span classdelimiter>"/span>span classcontent>launched_by/span>span classdelimiter>"/span>/span> : {span classkey>span classdelimiter>"/span>span classcontent>lb_name/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>Frank.Smith@abccompany.com/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>lb_source/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>Operation/span>span classdelimiter>"/span>/span>}}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 9. Journey JSON Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required./strong> Uniquely identifies a Client’s code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>If this optional property is set, the system will verify that thecode>trigger_id/code> is contained within the specified journey and if it is not an error will be returned./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>trigger_id/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Identifies the journey trigger to be launched.br>br>The Relay system generates a unique trigger_id when a user creates a journey in the CX Builder. The auto-generated trigger_id looks like: code>13425ae9-7ce7-4109-beeb-b0970894bbb2/code>.br>Additionally, a client can create a more user friendly trigger_id, like: code>Delivery-Reminder-2/code>, using the CX Builder. This API will accept either option./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>asset_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This asset id to override in the message./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>input_parameters/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>p classtableblock>This property contains a collection of input properties for the Journey.Input parameters are defined when the Journey is created or updated./p>p classtableblock>Each input property must be prefixed with code>input_/code>. All input parameter values must be of type string./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>launched_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This property contains a collection of launched-by name and launched-by source for the journey./p>/td>/tr>/tbody>/table>/div>/div>div classsect3>h4 id_http_response_3>a classlink href#_http_response_3>HTTP Response/a>/h4>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>81a332e3-2fec-4fcd-8d3d-68fe4531466e/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>recipients/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sent/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>result/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>999f6d96-c2a8-4111-9ff9-6db74c89ca4e/span>span classdelimiter>"/span>/span> } }, span classkey>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>results/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>12158372698/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ok/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>fb52e57e-8b27-4626-a2e5-9928cc7ac1cc/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sent/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>schedule/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>CRD-98027-004/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7028cb2e-d62d-4d5f-a285-91d25781ea86/span>span classdelimiter>"/span>/span> }, { span classkey>span classdelimiter>"/span>span classcontent>error/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Customer id BAK-11984-007 not found./span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>BAK-11984-007/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>d1f4260a-ff7c-44d8-a2e4-0dc30bc7a2cd/span>span classdelimiter>"/span>/span> } }/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 10. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The advance journey step was successfully submitted/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Journey/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>/div>/div>div classsect1>h2 id_consent_apis>a classlink href#_consent_apis>4. Consent APIs/a>/h2>div classsectionbody>div stylepage-break-after: always;>/div>div stylepage-break-after: always;>/div>div classsect2>h3 id_update_consent>a classlink href#_update_consent>4.1. Update Consent/a>/h3>div classparagraph>p>This API is used to change the consent_type for a specific notification channel./p>/div>div classsect3>h4 id_http_request_4>a classlink href#_http_request_4>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>PUT/strong> https://api.relayzone.com/platform/v3/api/messaging/client/strong>:client_id/strong>/consent/channel_addr/strong>:channel_addr/strong> /channel_type/strong>:channel_type/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>PUT/strong> https://api.relaystaging.com/platform/v3/api/messaging/client/strong>:client_id/strong>/consent/channel_addr/strong>:channel_addr/strong> /channel_type/strong>:channel_type/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_4>a classlink href#_url_parameters_4>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>channel_addr/td>td classhdlist2>p>Channel address: a mobile phone number/p>/td>/tr>tr>td classhdlist1>channel_type/td>td classhdlist2>p>Channel type: supported values are {sms}/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_4>a classlink href#_http_request_headers_4>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_request_body_3>a classlink href#_request_body_3>Request Body/a>/h5>div classparagraph>p>See: a href#consent-model>Consent Object/a>/p>/div>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>written|express|stop/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>/div>/div>div classsect3>h4 id_http_response_4>a classlink href#_http_response_4>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API will return details on the specified code>Consent/code>./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>consent/span>span classdelimiter>"/span>/span> : { span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>relay_developer/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>2017-07-05T22:16:12.934Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>2017-07-05T22:16:12.934Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>written|express|stop/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 11. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The code>Consent/code> was successfully returned/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Consent/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>/div>div classsect2>h3 id_bulk_update_consent>a classlink href#_bulk_update_consent>4.2. Bulk Update Consent/a>/h3>div classparagraph>p>This API is used to change the consent_types for multiple (up to 200) notification channels./p>/div>div classsect3>h4 id_http_request_5>a classlink href#_http_request_5>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>PUT/strong> https://api.relayzone.com/platform/v3/api/messaging/client/strong>:client_id/strong>/consent/bulk/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>PUT/strong> https://api.relaystaging.com/platform/v3/api/messaging/client/strong>:client_id/strong>/consent/bulkbr>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_5>a classlink href#_url_parameters_5>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_5>a classlink href#_http_request_headers_5>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_request_body_4>a classlink href#_request_body_4>Request Body/a>/h5>div classparagraph>p>See: a href#consent-model>Consent Object/a>/p>/div>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>batch/span>span classdelimiter>"/span>/span>: {span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>11015556789/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>stop/span>span classdelimiter>"/span>/span>}, {span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>11015552070/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>stop/span>span classdelimiter>"/span>/span>}, {span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>11015558218/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>,span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>stop/span>span classdelimiter>"/span>/span>} }/code>/pre>/div>/div>/div>/div>div classsect3>h4 id_http_response_5>a classlink href#_http_response_5>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API will return a 200 Accepted response to indicate the consent updates are processing./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>status/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>Accepted/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 12. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The code>Consent/code> was successfully returned/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>div classparagraph>p>Note: The length of the batch must be between 1 and 200, inclusive./p>/div>/div>/div>/div>/div>div classsect1>h2 id_cca_apis>a classlink href#_cca_apis>5. CCA APIs/a>/h2>div classsectionbody>div stylepage-break-after: always;>/div>div classsect2>h3 id_add_a_single_customer>a classlink href#_add_a_single_customer>5.1. Add a Single Customer/a>/h3>div classparagraph>p>This API is used to add a code>Customer/code> to the system./p>/div>div classsect3>h4 id_http_request_6>a classlink href#_http_request_6>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>POST/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/onboard/load-customer-record/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>POST/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/onboard/load-customer-recordbr>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_6>a classlink href#_url_parameters_6>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_6>a classlink href#_http_request_headers_6>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_request_body_5>a classlink href#_request_body_5>Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON body/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>secondary_account_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1970-01-01/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn-last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1111/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state-province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal-code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>member_since/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>1999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>membership_level/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>gold/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>renewal_date/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>05/01/2019/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>/div>/div>div classsect3>h4 id_http_response_6>a classlink href#_http_response_6>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API will load the posted code>Customer/code> in the system./p>/div>div classparagraph>p>See: a href#customer-model>Customer Object/a>/p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Accepted/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 13. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The code>Customer/code> was successfully loaded/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>/div>/div>/div>div classsect1>h2 id_customer_apis>a classlink href#_customer_apis>6. Customer APIs/a>/h2>div classsectionbody>div stylepage-break-after: always;>/div>div classsect2>h3 id_get_customer>a classlink href#_get_customer>6.1. Get Customer/a>/h3>div classparagraph>p>This API returns the attributes of a single Customer/p>/div>div classsect3>h4 id_http_request_7>a classlink href#_http_request_7>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>GET/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>GET/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_7>a classlink href#_url_parameters_7>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_7>a classlink href#_http_request_headers_7>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>/div>div classsect3>h4 id_http_response_7>a classlink href#_http_response_7>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API will return a Customer object./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>customer/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>548b648f-86dc-4f15-b556-e00a41f6e3dd/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-01-01T12:00:00Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_by/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>41469fa6-f678-4a4e-a5b0-416b31f6ee42/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_by_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Jim Collins/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-01-01T12:00:00Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_by/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>41469fa6-f678-4a4e-a5b0-416b31f6ee42/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_by_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Jim Collins/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>QaClient-5249-2334-5211-8618/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7873-1855-2986-5451/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Harrison/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Marc/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Rose/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1990-05-06/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn_last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1101/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span> : , span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>US/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 200/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address3/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>c/o Paul Raden/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Relay Network, Inc./span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1198751825/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_number/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>198751825/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>mobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>written|express|stop/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>phone_number/span>span classdelimiter>"/span>/span>: , span classkey>span classdelimiter>"/span>span classcontent>email/span>span classdelimiter>"/span>/span>: {}, span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>member_since/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>1999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>membership_level/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>gold/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>renewal_date/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>05/01/2019/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 14. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - Customer was successfully returned./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>div classsect2>h3 id_deactivate_customer_account>a classlink href#_deactivate_customer_account>6.2. Deactivate Customer Account/a>/h3>div classparagraph>p>This API deactivates a Customer Account, which include all notification channels associated with that Customer Account./p>/div>div classsect3>h4 id_http_request_8>a classlink href#_http_request_8>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>DELETE/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>DELETE/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_8>a classlink href#_url_parameters_8>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_8>a classlink href#_http_request_headers_8>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>/div>div classsect3>h4 id_http_response_8>a classlink href#_http_response_8>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API adds a deactivated: true flag to a customer record./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Customer {ccid} deactivated for client {client_id}/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 15. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - Customer was successfully deactivated./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>div classsect2>h3 id_update_the_product_group_of_a_customer>a classlink href#_update_the_product_group_of_a_customer>6.3. Update the Product Group of a Customer/a>/h3>div classparagraph>p>This API moves a customer from one product group to another within the same client./p>/div>div classsect3>h4 id_http_request_9>a classlink href#_http_request_9>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>PUT/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/move/strong>:product_group_id/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>PUT/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/move/strong>:product_group_id/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_9>a classlink href#_url_parameters_9>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>/p>/td>/tr>tr>td classhdlist1>product_group_id/td>td classhdlist2>p>The unique code>Product Group/code> identifier/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_9>a classlink href#_http_request_headers_9>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>/div>div classsect3>h4 id_http_response_9>a classlink href#_http_response_9>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API updates the product_group of a customer record./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Customer {ccid} moved to product-group-test-2 for client {client_id}/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 16. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - Customer was succesfully moved to a new Product Group./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>div classsect2>h3 id_add_a_phone_number_to_a_customer>a classlink href#_add_a_phone_number_to_a_customer>6.4. Add a phone number to a Customer/a>/h3>div classparagraph>p>This API adds a phone number to a customer./p>/div>div classsect3>h4 id_http_request_10>a classlink href#_http_request_10>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>PUT/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/add_phone/strong>:phone_number/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>PUT/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/add_phone/strong>:phone_number/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_10>a classlink href#_url_parameters_10>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>/p>/td>/tr>tr>td classhdlist1>phone_number/td>td classhdlist2>p>A 10 or 11 digits phone number/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_10>a classlink href#_http_request_headers_10>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_body_parameters>a classlink href#_body_parameters>Body Parameters/a>/h5>div classparagraph>p>These parameters should be placed in the body of the request/p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 25%;>col stylewidth: 58.3333%;>col stylewidth: 16.6667%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Parameter/th>th classtableblock halign-left valign-top>Description/th>th classtableblock halign-left valign-top>Required/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>consent_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>written or express/p>/td>td classtableblock halign-left valign-top>p classtableblock>Yes/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>phone_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>mobile, landline or unknown/p>/td>td classtableblock halign-left valign-top>p classtableblock>No (defaults to unknown)/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>country_code/p>/td>td classtableblock halign-left valign-top>p classtableblock>Positive integer lower than 1000/p>/td>td classtableblock halign-left valign-top>p classtableblock>No ( defaults to 1)/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_source/p>/td>td classtableblock halign-left valign-top>p classtableblock>an optional source value/p>/td>td classtableblock halign-left valign-top>p classtableblock>No ( defaults to an internal channel value)/p>/td>/tr>/tbody>/table>/div>div classsect4>h5 id_request_body_6>a classlink href#_request_body_6>Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON Body/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>express/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>mobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>:span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_source/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>custom client source/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>/div>/div>div classsect3>h4 id_http_response_10>a classlink href#_http_response_10>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API adds the phone number to the array of notification channels in the customer record./p>/div>div classparagraph>p>Currently, relay permits up to 50 phone numbers associated to one CCID andup to 50 CCIDs can be associated to a specific phone number./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Phone number {phone_number} has been added to customer with ccid {ccid} for client {client_id}/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 17. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The phone number was succesfully added to the customer record/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>div classsect2>h3 id_remove_a_phone_number_from_a_customer>a classlink href#_remove_a_phone_number_from_a_customer>6.5. Remove a phone number from a Customer/a>/h3>div classparagraph>p>This API removes a phone number from a customer./p>/div>div classsect3>h4 id_http_request_11>a classlink href#_http_request_11>HTTP Request/a>/h4>div classsidebarblock>div classcontent>div classparagraph>div classtitle>Production URL/div>p>strong>PUT/strong> https://api.relayzone.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/remove_phone/strong>:phone_number/strong>/p>/div>div classparagraph>div classtitle>Staging URL/div>p>strong>PUT/strong> https://api.relaystaging.com/platform/v3/api/cdm/client/strong>:client_id/strong>/customer/strong>:ccid/strong>/remove_phone/strong>:phone_number/strong>br>/p>/div>/div>/div>div classsect4>h5 id_url_parameters_11>a classlink href#_url_parameters_11>URL Parameters/a>/h5>div classhdlist>table>tr>td classhdlist1>client_id/td>td classhdlist2>p>Identifies the unique code>Client/code>/p>/td>/tr>tr>td classhdlist1>ccid/td>td classhdlist2>p>Identifies a unique client code>Customer/code>. If code>ALL/code> is passed, applies to all customers of the client./p>/td>/tr>tr>td classhdlist1>phone_number/td>td classhdlist2>p>A 10 or 11 digits phone number/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_http_request_headers_11>a classlink href#_http_request_headers_11>HTTP Request Headers/a>/h5>div classparagraph>p>em>Unless specifically noted, all headers are required/em>/p>/div>div classhdlist>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>tr>td classhdlist1>xx-relay-api-key/td>td classhdlist2>p>Must contain the Relay provided API key/p>/td>/tr>/table>/div>/div>div classsect4>h5 id_body_parameters_2>a classlink href#_body_parameters_2>Body Parameters/a>/h5>div classparagraph>p>These parameters should be placed in the body of the request/p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 25%;>col stylewidth: 58.3333%;>col stylewidth: 16.6667%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Parameter/th>th classtableblock halign-left valign-top>Description/th>th classtableblock halign-left valign-top>Required/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>client_source/p>/td>td classtableblock halign-left valign-top>p classtableblock>an optional source value/p>/td>td classtableblock halign-left valign-top>p classtableblock>No ( defaults to an internal channel value)/p>/td>/tr>/tbody>/table>/div>div classsect4>h5 id_request_body_7>a classlink href#_request_body_7>Request Body/a>/h5>div classlistingblock>div classtitle>Example JSON Body/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>client_source/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>custom client source/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>/div>/div>div classsect3>h4 id_http_response_11>a classlink href#_http_response_11>HTTP Response/a>/h4>div classparagraph>p>On success (200), this API removes the phone number from the array of notification channels in the customer record./p>/div>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Phone number {phone_number} has been removed from customer with ccid {ccid} for client {client_id}/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 18. HTTP Response Codes/caption>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The phone number was succesfully removed from the customer record/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>400/p>/td>td classtableblock halign-left valign-top>p classtableblock>BAD REQUEST - There was an issue with the request. The response body will contain additional information related to the bad request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>401/p>/td>td classtableblock halign-left valign-top>p classtableblock>UNAUTHORIZED - The API token does not have authorization to the requested resource./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>NOT FOUND - The requested resource was not found. Please verify the route parameter./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>409/p>/td>td classtableblock halign-left valign-top>p classtableblock>CONFLICT - Indicates the request could not be processed. A common reason is when attempting to create a new code>Customer/code>object, but the ID already exists in the system./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>SERVER ERROR - An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request./p>/td>/tr>/tbody>/table>/div>/div>/div>/div>h1 id_customer_validation_rest_api classsect0>a classlink href#_customer_validation_rest_api>Customer Validation REST API/a>/h1>div classsect1>h2 id_overview_2>a classlink href#_overview_2>7. Overview/a>/h2>div classsectionbody>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>This API is designed to be implemented by the Client to provide real-time Customer validation./td>/tr>/table>/div>div classparagraph>p>When a Customer is self on-boarding to the Relay platform through a dynamic channel such as IVR, agent on-boarding, or sign up pages, Relay will make a real-time call to the strong>Validation API/strong> to validate the information provide by the Customer. If the Customer provided information matches, the API must return a success response code of 200, at which point Relay will onboard the Customer to the system./p>/div>div classparagraph>p>The Client system must be designed with high scalability in order to handle peak loads of simultaneous on-boarding API requests being made from the Relay platform./p>/div>div classparagraph>p>All communications to the Client server must be over a secure HTTPS connection./p>/div>/div>/div>div classsect1>h2 id_implementation>a classlink href#_implementation>8. Implementation/a>/h2>div classsectionbody>h3 id_url_endpoint classdiscrete>URL Endpoint/h3>div classadmonitionblock important>table>tr>td classicon>i classfa icon-important titleImportant>/i>/td>td classcontent>The strong>Validation API/strong> must be exposed over an HTTPS endpoint leveraging TLS 1.2+. Relay will not attempt to call any endpoint over an insecure HTTP connection./td>/tr>/table>/div>div classparagraph>p>You must provide the URL endpoint for the strong>Validation API/strong> to Relay./p>/div>h3 id_authentication_2 classdiscrete>Authentication/h3>div classparagraph>p>The Relay system supports the following types of authentication:/p>/div>div classulist>ul>li>p>Basic auth/p>/li>li>p>API key/p>/li>li>p>OAuth/p>/li>li>p>JWT/p>/li>/ul>/div>h3 id_example_http_request classdiscrete>Example HTTP Request/h3>div classsidebarblock>div classcontent>div classparagraph>p>strong>POST/strong> https://strong>${client-host-name}/strong>/relay/cca-validation/p>/div>/div>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Relay is flexible to the URL path. The default path is code>code>/relay/cca-validation/code>/code>/td>/tr>/table>/div>div classhdlist>div classtitle>URL Parameters/div>table>tr>td classhdlist1>${client-host-name}/td>td classhdlist2>p>This will be replaced by the Client provided host name./p>/td>/tr>/table>/div>div classhdlist>div classtitle>Request Headers/div>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example JSON Request/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>yyyy-mm-dd/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h3 id_http_response_12 classdiscrete>HTTP Response/h3>div classhdlist>div classtitle>Response Headers/div>table>tr>td classhdlist1>Content-Type/td>td classhdlist2>p>application/json/p>/td>/tr>/table>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>HTTP Code/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>200/p>/td>td classtableblock halign-left valign-top>p classtableblock>OK - The Customer is valid and additional Customer properties may have been returned/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>404/p>/td>td classtableblock halign-left valign-top>p classtableblock>Not Found - The Customer is not valid within the Client system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>500/p>/td>td classtableblock halign-left valign-top>p classtableblock>Server Error - There was an error on the server side. The body of the HTTP response must include details on the error./p>/td>/tr>/tbody>/table>div classlistingblock>div classtitle>Example JSON Response/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7873-1855-2986-5451/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span> : , span classkey>span classdelimiter>"/span>span classcontent>secondary_account_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Harrison/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Marc/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Rose/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1990-05-06/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn_last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1101/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>US/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 200/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address3/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>c/o Paul Raden/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Relay Network, Inc./span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { }}/code>/pre>/div>/div>div classparagraph>p>See: a href#CCA-model>CCA Object/a>/p>/div>/div>/div>h1 id_push_event_webhook classsect0>a classlink href#_push_event_webhook>Push Event Webhook/a>/h1>div classsect1>h2 id_overview_3>a classlink href#_overview_3>9. Overview/a>/h2>div classsectionbody>div classparagraph>p>Webhooks are used by Relay to inform your system of events that are taking place within the Relay platform. Example events include SMS events, click-throughs, mobile consent changes (e.g. stops) and when an end-user engages on the Relay Feed just to name a few./p>/div>div classparagraph>p>When an event occurs, Relay will make an HTTPS POST call to the Webhook URL you have configured. The HTTPS request will include the details of the event that occurred./p>/div>div classparagraph>p>The Relay Webhook supports single event transactions (one per HTTPS call)./p>/div>div classsect2>h3 id_example_event_flow>a classlink href#_example_event_flow>9.1. Example Event Flow/a>/h3>div classimageblock>div classcontent>img srcimages/overview-example-event-flow.png altoverview example event flow>/div>/div>h3 id_event_properties classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24.2424%;>col stylewidth: 42.4242%;>col stylewidth: 33.3334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Legend/th>th classtableblock halign-left valign-top>Areas of Control/th>th classtableblock halign-left valign-top>Events/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>div classcontent>div classimageblock>div classcontent>img srcimages/overview-client-controlled.png altoverview client controlled>/div>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Input Data/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>/div>/td>/tr>tr>td classtableblock halign-left valign-top>div classcontent>div classimageblock>div classcontent>img srcimages/overview-relay-controlled.png altoverview relay controlled>/div>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Connection Management,br>Feed Message Delivery,br>SMS Notification requests to Kaleyra/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>account.deactivatebr>channel_consent.updatebr>notification_channel.addbr>notification_channel.removebr>message.deliveredbr>message.undeliveredbr>notification.attemptedbr>notification.not_attempted/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>div classcontent>div classimageblock>div classcontent>img srcimages/overview-kaleyra-controlled.png altoverview kaleyra controlled>/div>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>SMS Notification requests to Carriersbr>Delivery receipts from Carriers to Relay/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>notification.deliveredbr>notification.undelivered/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>div classcontent>div classimageblock>div classcontent>img srcimages/overview-customer-controlled.png altoverview customer controlled>/div>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Auth links clickedbr>Actions taken/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>notification.auth_link_clickedbr>message.action_taken/p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 id_event_ordering>a classlink href#_event_ordering>9.2. Event Ordering/a>/h3>div classparagraph>p>Do to the nature of the system, it is possible for events to arrive slightly out of order. For example you may receive a code>notification.undelivered/code> event before the notification.attempted event. However, event timestamp, in the code>event_ts/code> field, is accurate and can be used in any processing logic./p>/div>div classadmonitionblock important>table>tr>td classicon>i classfa icon-important titleImportant>/i>/td>td classcontent>div classulist>ul>li>p>Do not assume events will arrive in exact time stamp order/p>/li>li>p>Do not assume events will arrive in a logical progression order/p>/li>/ul>/div>/td>/tr>/table>/div>/div>div classsect2>h3 id_filtering_events>a classlink href#_filtering_events>9.3. Filtering Events/a>/h3>div classparagraph>p>The Relay system emits a large number of different event types. The webhook can be configured to only send events you are interested in./p>/div>/div>div classsect2>h3 id_implementation_2>a classlink href#_implementation_2>9.4. Implementation/a>/h3>div classparagraph>p>To receive the webhook events from Relay, you must implement a minimal web endpoint that can accept HTTPS requests./p>/div>div classadmonitionblock important>table>tr>td classicon>i classfa icon-important titleImportant>/i>/td>td classcontent>The webhook must be exposed over an HTTPS endpoint leveraging TLS 1.2+. Relay will not attempt to call the webhook over an insecure HTTP connection./td>/tr>/table>/div>/div>div classsect2>h3 id_authentication_3>a classlink href#_authentication_3>9.5. Authentication/a>/h3>div classparagraph>p>The Relay webhook system supports the following types of authentication using standard best practices:/p>/div>div classulist>ul>li>p>Basic auth/p>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langbash>curl --location --request POST $CUSTOM_ENDPOINT \--header Authorization: basic $BASE64_AUTH_STRING \--header Content-Type: application/json \--data-raw { "event_id": "ip-10-3-0-224-668176-8h-b98185e8-8a01-406f-a9e9-a62a2e437da7-1mha", "event_ts": "2022-04-12T14:53:11.958Z", "payload": { "action_type": null, "product_group_id": "default", "trigger_id": "91c08533-3ebe-49e3-a44a-4d885744feaf", "channel_addr": "", "channel_type": "", "ccid": "relay_pushAPI_customer", "journey_id": "ee0af7fa-e278-4bbb-83b6-b04cf6612e04", "action_value": null, "relay_tracking_id": "6d5d4d44-3982-456f-b694-7ce39b229889", "message_id": "43244abd-45dc-4b27-8682-54337554c876", "message_name": "Relay Push API Message", "notification_id": null, "action_label": null, "client_id": "relay_push_api_sample", "event_type": "message", "client_message_tag": "", "job_id": "6f7970db-6040-4fb2-80e1-f43646e9e75e", "customer_id": "325030d6-8135-4e55-82b3-272eab6e77e3", "event_subtype": "delivered" }, "event_name": "message.delivered"}/code>/pre>/div>/div>/li>li>p>API key/p>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langbash>curl --location --request POST $CUSTOM_ENDPOINT \--header Content-Type: application/json \--header ApiKey: $API_KEY \--data-raw { "event_id": "ip-10-3-0-224-668176-8h-b98185e8-8a01-406f-a9e9-a62a2e437da7-1mha", "event_ts": "2022-04-12T14:53:11.958Z", "payload": { "action_type": null, "product_group_id": "default", "trigger_id": "91c08533-3ebe-49e3-a44a-4d885744feaf", "channel_addr": "", "channel_type": "", "ccid": "relay_pushAPI_customer", "journey_id": "ee0af7fa-e278-4bbb-83b6-b04cf6612e04", "action_value": null, "relay_tracking_id": "6d5d4d44-3982-456f-b694-7ce39b229889", "message_id": "43244abd-45dc-4b27-8682-54337554c876", "message_name": "Relay Push API Message", "notification_id": null, "action_label": null, "client_id": "relay_push_api_sample", "event_type": "message", "client_message_tag": "", "job_id": "6f7970db-6040-4fb2-80e1-f43646e9e75e", "customer_id": "325030d6-8135-4e55-82b3-272eab6e77e3", "event_subtype": "delivered" }, "event_name": "message.delivered"}/code>/pre>/div>/div>/li>li>p>OAuth/p>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langbash>curl --location --request POST $CUSTOM_ENDPOINT \--header Content-Type: application/json \--header Authorization: $BEARER_TOKEN \--data-raw { "event_id": "ip-10-3-0-224-668176-8h-b98185e8-8a01-406f-a9e9-a62a2e437da7-1mha", "event_ts": "2022-04-12T14:53:11.958Z", "payload": { "action_type": null, "product_group_id": "default", "trigger_id": "91c08533-3ebe-49e3-a44a-4d885744feaf", "channel_addr": "", "channel_type": "", "ccid": "relay_pushAPI_customer", "journey_id": "ee0af7fa-e278-4bbb-83b6-b04cf6612e04", "action_value": null, "relay_tracking_id": "6d5d4d44-3982-456f-b694-7ce39b229889", "message_id": "43244abd-45dc-4b27-8682-54337554c876", "message_name": "Relay Push API Message", "notification_id": null, "action_label": null, "client_id": "relay_push_api_sample", "event_type": "message", "client_message_tag": "", "job_id": "6f7970db-6040-4fb2-80e1-f43646e9e75e", "customer_id": "325030d6-8135-4e55-82b3-272eab6e77e3", "event_subtype": "delivered" }, "event_name": "message.delivered"}/code>/pre>/div>/div>/li>/ul>/div>/div>div classsect2>h3 id_individual_event_processing>a classlink href#_individual_event_processing>9.6. Individual Event Processing/a>/h3>div classlistingblock>div classtitle>Example Individual Event Payload/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>4378439B-1D30-4405-ABE0-BF7F338F3788/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.auth_link_used/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2021-04-14T12:00:00.000Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1002/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>acme_corp/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>10005552222/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9006E214-5261-4736-9192-B0ADD3005723/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>A689672A-0A6E-4E99-8C5D-1CAD3728CA32/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>44BE6B5D-26B1-40EA-9750-2E8C82067AF6/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F0920F03-8D38-4C7B-A03A-14F47634E3D1/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>nickname/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2B7C306C-0F48-4F18-8F4D-205A00408E4D/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>0AC9067B-D91A-4744-B8F6-6290B2DCCE6B/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F9564106-C25A-4FD2-A9DF-F26ADC1D1362/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>/div>div classsect2>h3 id_webhook_response>a classlink href#_webhook_response>9.7. Webhook Response/a>/h3>div classparagraph>p>If the webhook is configured for batch processing then the response is related to the entire batch. Therefore, if a 200 is returned the entire batch is marked accepted and if a 500 is returned the entire batch is marked as error and the same batch will be retried./p>/div>div classparagraph>p>The following webhook response codes are supported:/p>/div>div classhdlist>table>tr>td classhdlist1>200/td>td classhdlist2>p>Success, the event payload was accepted. While you can provide information in the body Relay will not process it in any way./p>/td>/tr>tr>td classhdlist1>401/td>td classhdlist2>p>Invalid access. This can occur if the authentication is not properly configured./p>/td>/tr>tr>td classhdlist1>500/td>td classhdlist2>p>Service is down. Relay will retry the request as outlined in the Retry section below/p>/td>/tr>/table>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>If your endpoint has a business or logic error while processing the request, do not respond to the webhook with a 400 as it will not be relevant to Relay. Instead you should log the error in your system, save the request body for your teams further analysis and return a 200 to Relay./td>/tr>/table>/div>/div>div classsect2>h3 id_scaling>a classlink href#_scaling>9.8. Scaling/a>/h3>div classparagraph>p>When implementing the webhook interface it is important that your backend system can scale to handle the volume of events being emitted from the Relay system. Ensure your IT team, implementing the webhook, is informed on how the Relay system operates and what will trigger a webhook call./p>/div>div classparagraph>p>For example, if you submit a large CSV file for processing with 1m records, Relay could start hitting the webhook at a rate of several thousands calls per minute - especially for the individual (non batch) requests./p>/div>div classparagraph>p>If scaling is a concern, switching to the batch processing may be beneficial./p>/div>/div>div classsect2>h3 id_retry_logic>a classlink href#_retry_logic>9.9. Retry Logic/a>/h3>div classparagraph>p>In the event that the webhook returns a 500, or if the call to the webhook timeouts, Relay will a total of strong>four/strong> attempts to send the event (with delays in-between each retry). If the fourth attempt fails, Relay will log the error and then move onto the next event. This will prevent a case where there is an issue processing the specific request and creating an endless loop of errors./p>/div>/div>div classsect2>h3 id_schedule_webhook_downtime>a classlink href#_schedule_webhook_downtime>9.10. Schedule Webhook Downtime/a>/h3>div classadmonitionblock important>table>tr>td classicon>i classfa icon-important titleImportant>/i>/td>td classcontent>If your webhook will be offline for any scheduled maintenance, please contact your Relay Client Success Manager and provide the date and times of when the webhook will be offline./td>/tr>/table>/div>/div>/div>/div>div classsect1>h2 id_push_events>a classlink href#_push_events>10. Push Events/a>/h2>div classsectionbody>h3 id_event_payload classdiscrete>Event Payload/h3>div classparagraph>p>All webhook events are sent in JSON format with a standard envelope containing the event name, event timestamp, unique event id and payload. The payload will contain additional properties based on the event that was emitted. Please see the individual webhook event documentation for complete details on each event’s specific payload properties./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>When parsing the event payload, Relay strongly recommends following the em>Tolerant Reader Pattern/em> (a hrefhttp://servicedesignpatterns.com/WebServiceEvolution/TolerantReader classbare>http://servicedesignpatterns.com/WebServiceEvolution/TolerantReader/a>). In summary, this pattern says - Parse only the fields you are interested in and ignore everything else including strict validation. Relay, in the future, may add additional properties to and existing event and following the em>Tolerant Reader Pattern/em> will ensure your existing integration does not break./td>/tr>/table>/div>h3 id_available_events classdiscrete>Available Events/h3>h4 id_connection_events classdiscrete>Connection Events/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 25%;>col stylewidth: 25%;>col stylewidth: 50%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Event/th>th classtableblock halign-left valign-top>Event Description/th>th classtableblock halign-left valign-top>Event Use/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>a href#account.deactivate>account.deactivate/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The end user account has been deactivated/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Use if deactivation processes are utilized and an flag to indicate a deactivated account is helpful in downstream processing. A deactivation process will trigger notification_channel.remove events for all phone numbers connected to the account and then an account.deactive event./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#channel_consent.update>channel_consent.update/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>Consent has changed for the channel/p>/td>td classtableblock halign-left valign-top>p classtableblock>Use to keep a Client consent store in sync with Relay’s consent store. When Relay reports a consent change, the same change is made to the Client consent store./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification_channel.add>notification_channel.add/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>A notification channel has been added to the customer account/p>/td>td classtableblock halign-left valign-top>p classtableblock>Use to keep a Client connection DB in sync with Relay’s connection DB. When Relay reports a notification channel add, it indicates a new phone number has been joined to the CCID. The act of adding a phone number to an account requires consent. If the consent of the phone number being added is new or changes from what is stored in Relay, a channel_consent.update event will also emit./p>p classtableblock>This may be paired with a notification_channel.remove event when updating the phone number of an account./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification_channel.remove>notification_channel.remove/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>A notification channel has been removed from the customer account/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to keep a Client connection DB in sync with Relay’s connection DB. When Relay reports a notification channel remove, it indicates a phone number has been removed from the CCID. The act of removing a phone number from an account DOES NOT update the consent associated to the phone number./p>p classtableblock>This may be paired with a notification_channel.add event when updating the phone number of an account./p>/td>/tr>/tbody>/table>h4 id_experience_events classdiscrete>Experience Events/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 25%;>col stylewidth: 25%;>col stylewidth: 50%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Event/th>th classtableblock halign-left valign-top>Event Description/th>th classtableblock halign-left valign-top>Event Use/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>a href#message.delivered>message.delivered/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The message was posted to the Customer’s feed/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the successful posting of a message to a Customer’s feed./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#message.undelivered>message.undelivered/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The message failed to post to the Customer’s feed/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to identify bad connections, missing input parameters, and duplicates. When Relay reports a message undelivered event, it also reports a reason./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification.attempted>notification.attempted/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The SMS notification was attempted/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the successful send of an SMS from Relay to our SMS aggregator./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification.not_attempted>notification.not_attempted/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The SMS notification was not attempted/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to identify accounts without consent, missing input parameters and duplicates. When Relay reports a notification not attempted event, it also reports a reason./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification.attempted>notification.delivered/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The SMS was delivered to the Customer’s mobile device/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the successful delivery of an SMS notification to a Customer’s device. This event is provided by our SMS aggregator and may take up to 72 hours after notification attempted for this event to be received by Relay./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification.attempted>notification.undelivered/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The SMS failed delivery to the Customer’s mobile device/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the unsuccessful delivery of an SMS notification to a Customer’s device. This event is provided by our SMS aggregator and may take up to 72 hours after notification attempted for this event to be received by Relay./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#notification.auth_link_used>notification.auth_link_used/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The Customer clicked on the auth link in their notification/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the clicking of an auth link in a notification by the Customer. By clicking an auth link, the Customer is taken to a message on their feed. From there, the Customer could interact with any message on the feed, not just the message associated directly to the auth link clicked./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a href#message.action_taken>message.action_taken/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>The Customer took an action on their feed/p>/td>td classtableblock halign-left valign-top>p classtableblock>Used to track the actions taken in the feed by a Customer/p>/td>/tr>/tbody>/table>div classsect2>h3 idchannel_consent.update>a classlink href#channel_consent.update>10.1. Event: channel_consent.update/a>/h3>div classparagraph>p>This event is emitted any time the user’s consent is changed./p>/div>div classimageblock>div classcontent>img srcimages/webhook-event-channel-consent-update-flow.png altwebhook event channel consent update flow>/div>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ip-10-1-4-153-2096492-az-b1849c0f-1584-48bf-8201-deda9fa6670e-1oz9/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2022-03-28T22:00:09.614Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>source_channel/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>csr/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11058559276/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>opt-me-out/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>a642b9a0-af0d-449f-9069-57a853b5c734/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>previous_consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>written/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>relay_network/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>stop/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>channel_consent.update/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_event_properties_2 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>source_channel/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the source where the event originated from./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>previous_consent_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the previous consent for the Customer./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer previously did not have any consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer previously had express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer previously had written consent./p>/td>/tr>tr>td classhdlist1>null/td>td classhdlist2>p>The empty consent value that did not change previously./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>consent_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the current consent for the Customer./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer currently does not have any consent. No SMS messages will be sent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer currently has express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer currently has written consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>channel_consent.update/code>/p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idaccount.deactivate>a classlink href#account.deactivate>10.2. Event: account.deactivate/a>/h3>div classparagraph>p>This event is emitted when a user (Customer) is deactivated from the Relay platform. Once a user is deactivated, they will no longer be able to receive notifications or access their Feed./p>/div>div classimageblock>div classcontent>img srcimages/webhook-event-account-deactivate-flow.png altwebhook event account deactivate flow>/div>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ip-10-2-4-110-1633159-q2t-77656a49-5061-42ed-8ef6-f0ece8705a83-208w/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2022-04-12T01:13:43.126Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>deactive-my-ccid/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>5f1d883f-3e7c-4d93-9cb8-d59359b81e81/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>relay_network/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7341e921-ba16-46f2-a330-476ae7d36f9a/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>source_channel/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>deactivate-api/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11058559276/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span> }, { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11904477901/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span> } }, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>account.deactivate/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_event_properties_3 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>source_channel/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the source where the event originated from./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_channels/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>array This collections contains zero or more notification channels. Each notification channel is defined by a combination of code>channel_type/code> and code>channel_addr/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>account.deactivate/code>/p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idmessage.action_taken>a classlink href#message.action_taken>10.3. Event: message.action_taken/a>/h3>div classparagraph>p>This event is emitted when a user takes an action on the em>Feed/em>. The code>action_types/code> property of the event structure identifies the specific type of action that occurred./p>/div>div classhdlist>div classtitle>Summary of action_type values/div>table>tr>td classhdlist1>call/td>td classhdlist2>p>The user click the call phone number action button/p>/td>/tr>tr>td classhdlist1>collapsible/td>td classhdlist2>p>The user expanded a collapsible section/p>/td>/tr>tr>td classhdlist1>email/td>td classhdlist2>p>The user clicked on an email action button/p>/td>/tr>tr>td classhdlist1>hyperlink/td>td classhdlist2>p>The user clicked on a hyperlink navigation button/p>/td>/tr>tr>td classhdlist1>message_branch/td>td classhdlist2>p>The user clicked on a message branch/p>/td>/tr>tr>td classhdlist1>twoway/td>td classhdlist2>p>The user clicked on two way action button/p>/td>/tr>tr>td classhdlist1>consent_upgrade/td>td classhdlist2>p>The user clicked on consent upgrade button/p>/td>/tr>tr>td classhdlist1>email_data_capture/td>td classhdlist2>p>The user captured the email data/p>/td>/tr>tr>td classhdlist1>form_info_capture/td>td classhdlist2>p>The user captured the form info/p>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>568C69C9-702D-478B-BC00-923C3F9F3BDD/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>message.action_taken/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-01-01T12:00:00.000Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>action_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>call/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>action_label/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Call customer service/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>action_value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>(800) 555-1212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1000-aa-13CE/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>call-support/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>10005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9006E214-5261-4736-9192-B0ADD3005723/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>A689672A-0A6E-4E99-8C5D-1CAD3728CA32/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>44BE6B5D-26B1-40EA-9750-2E8C82067AF6/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>3AE05D87-B00E-42E7-9D68-C16C73B68162/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>nickname/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8BD6EBD9-94F4-4746-82DA-542E98D86823/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>99999999-8888-7777-6666-555555555555/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F9564106-C25A-4FD2-A9DF-F26ADC1D1362/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>h4 id_event_properties_4 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>message.action_taken/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Indicate what kind of action was taken by the user.See below for additional documentation on each specific code>action_type/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The action label describing the action to the user./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The action value which is dependent on the type of action.See below for additional documentation on each specific code>action_value/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>/tbody>/table>div classsect3>h4 id_action_types>a classlink href#_action_types>Action Types/a>/h4>div classparagraph>p>There are several different action events that can take place in the Feed. The event payload data depends on the type of action an event represents./p>/div>h5 id_action_call classdiscrete>Action: call/h5>div classparagraph>p>The user clicked on a call action button. This action will open the device’s default phone application with the phone number pre-populated. However, this does not mean the user actually placed the call becuase the user can cancel the phone action which is not reported back to the Relay application./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>call/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the phone number to be called/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The phone number that was attempted to be called/p>/td>/tr>/tbody>/table>h5 id_action_collapsible classdiscrete>Action: collapsible/h5>div classparagraph>p>The user expanded a collapsible section./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>collapsible/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>The text of the label identifying the collapsible section that was expanded/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>n/a/p>/td>/tr>/tbody>/table>h5 id_action_email classdiscrete>Action: email/h5>div classparagraph>p>The user clicked on an code>email/code> action. This action will open the device’s default email application with the code>to:/code> field prepopulated. However, this action does not imply that an actual email was sent as the user could have canceled the send action from the email application./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>email/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>The label describing the target email address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>The destination email address (e.g. the code>to:/code> field)/p>/td>/tr>/tbody>/table>h5 id_action_hyperlink classdiscrete>Action: Hyperlink/h5>div classparagraph>p>The user clicked on a hyperlink action button./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>hyperlink/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>The text of the label describing the hyperlink/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>The value of the hyperlink/p>/td>/tr>/tbody>/table>h5 id_action_message_branch classdiscrete>Action: message_branch/h5>div classparagraph>p>The user clicked on a message branch. A message branch is a sub message in the feed./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>message_branch/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the messsage branch/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The message id of the branch that was taken/p>/td>/tr>/tbody>/table>h5 id_action_chat classdiscrete>Action: Chat/h5>div classparagraph>p>The user clicked the Relay two-wat chat button. This opens the Relay two-way chat system./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>chat/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>This label describing the two-way chat action/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>This value will be the same as code>action_label/code>/p>/td>/tr>/tbody>/table>h5 id_action_twoway classdiscrete>Action: twoway/h5>div classparagraph>p>The user clicked on two way action button./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>twoway/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the two-way/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The value of the two-way/p>/td>/tr>/tbody>/table>h5 id_action_consent_upgrade classdiscrete>Action: consent_upgrade/h5>div classparagraph>p>The user clicked on consent upgrade button./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>consent_upgrade/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the consent upgrade/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The value of the consent upgrade/p>/td>/tr>/tbody>/table>h5 id_action_email_data_capture classdiscrete>Action: email_data_capture/h5>div classparagraph>p>The user captured the email data./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>email_data_capture/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the email data capture/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The value of email data that was captured/p>/td>/tr>/tbody>/table>h5 id_action_form_info_capture classdiscrete>Action: form_info_capture/h5>div classparagraph>p>The user captured the form info./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>action_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>code>form_info_capture/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_label/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The text of the label describing the form info capture/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>action_value/p>/td>td classtableblock halign-left valign-top>p classtableblock>string The value of form information that was captured/p>/td>/tr>/tbody>/table>/div>/div>div classsect2>h3 idmessage.delivered>a classlink href#message.delivered>10.4. Event: message.delivered/a>/h3>div classparagraph>p>This event is emitted when the system successfully posted a message to the Customer’s Feed./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>68EB7899-28D1-4546-9F97-F6E76EE9C184/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>message.delivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-10-16T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1001/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>welcome/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>0000-0000-0000-0000/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>3432c918-2b99-41b0-a7ab-36b312f3620b/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>97s34a57-2816-489a-b78c-a4310abf232b/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1ffdca03-714e-4280-8681-3d3a33f38043/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Welcome/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> span classstring>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>06ac1498-ff5e-4831-b686-62177ed249a5/span>span classdelimiter>"/span>/span> span classstring>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8945B43E-A68E-434C-B5F1-FAC1A5731B0C/span>span classdelimiter>"/span>/span>, },}/code>/pre>/div>/div>h4 id_event_properties_5 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>message.delivered/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request.UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idmessage.undelivered>a classlink href#message.undelivered>10.5. Event: message.undelivered/a>/h3>div classparagraph>p>This event is emitted when the system was unable to add the message to the Customer’s Feed. Review the em>error_type/em> and em>error_string/em> for the undelivered reason./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>When a message is undelivered, this means that a SMS notification will strong>not/strong> be sent to the Customer./td>/tr>/table>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>68EB7899-28D1-4546-9F97-F6E76EE9C184/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>message.undelivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-10-16T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>v3_j_11/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>client-provided-identifier/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>0000-0000-0000-0000/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>3432c918-2b99-41b0-a7ab-36b312f3620b/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>97s34a57-2816-489a-b78c-a4310abf232b/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1ffdca03-714e-4280-8681-3d3a33f38043/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Welcome/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8BD6EBD9-94F4-4746-82DA-542E98D86823/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>06ac1498-ff5e-4831-b686-62177ed249a5/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8945B43E-A68E-434C-B5F1-FAC1A5731B0C/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>error_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>trigger-not-found/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>error_string/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>No journey found for trigger_id None./span>span classdelimiter>"/span>/span>, }}/code>/pre>/div>/div>h4 id_event_properties_6 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>message.undelivered/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>error_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the type of error that occurred. Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>ccid-not-found/td>td classhdlist2>p>The CCID specified was not found/p>/td>/tr>tr>td classhdlist1>duplicate-request/td>td classhdlist2>p>The same message was already sent within the duplicate supression time window/p>/td>/tr>tr>td classhdlist1>missing-fields/td>td classhdlist2>p>The message requires dynamic input values that were not passed in with the request/p>/td>/tr>tr>td classhdlist1>invalid-html-in-wire-message/td>td classhdlist2>p>The experience may have an invalid HTML tag in the message or SMS body./p>/td>/tr>tr>td classhdlist1>invalid-html-in-sms-message/td>td classhdlist2>p>The experience may have an invalid HTML tag in the message or SMS body./p>/td>/tr>tr>td classhdlist1>throttle-customer/td>td classhdlist2>p>Message exceeds SMS send window threshold./p>/td>/tr>tr>td classhdlist1>duplicate-request/td>td classhdlist2>p>The same message was already sent within the duplicate suppression time window./p>/td>/tr>tr>td classhdlist1>trigger-not-found/td>td classhdlist2>p>The trigger_id could not be found for the corresponding client_id./p>/td>/tr>tr>td classhdlist1>journey-archived/td>td classhdlist2>p>The experience has been archived./p>/td>/tr>tr>td classhdlist1>customer-deactivated/td>td classhdlist2>p>The customer specified has been deactivated./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>error_string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string A human readable error string./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification.attempted>a classlink href#notification.attempted>10.6. Event: notification.attempted/a>/h3>div classparagraph>p>This event is emitted when Relay sends an SMS message to our aggregator and the aggregagtor responded successfully that the request has been received and is sending to the carrier for final delivery to the mobile device./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>320A93CE-F356-4379-B14B-EE01C31FB2C9/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.attempted/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-10-16T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1001/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>26534380-FE62-46C8-8FA2-10143A6FC165/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9E3D8ADC-E70E-4351-B559-4805CFA4FB35/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>attempted/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EA637AD1-CCC3-4EF6-A3F0-CC5E25667181/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EB78F251-F773-4B03-9868-8C5F7B0C200E/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>A32DC255-24A0-4388-BBF8-42AAF42C7D12/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>516ED2CD-CA4E-4A0D-B5F7-44DE600F854C/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EE9E5353-10CB-492B-8A8F-BA85AA675E87/span>span classdelimiter>"/span>/span> span classstring>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>392C875C-9EC0-49E3-B39A-A37434E78493/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>sms_text/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Welcome to One Life Health/span>span classchar>\n/span>span classcontent> @{auth-link} Text help or stop. Msg&DataRatesMayApply/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>launched_by/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>lb-name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>system-initiated/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>lb-source/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>system-initiated/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>h4 id_event_properties_7 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification.attempted/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>sms_text/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The actual text of the SMS message that was sent./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>launched_by/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional object that contains details on the source of the notification./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>lb-name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Launched by name. If set, identifies the name of the user that triggered the notification./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>lb-source/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Launched by source. If set, identifies the source system that triggered the notification./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification.not_attempted>a classlink href#notification.not_attempted>10.7. Event: notification.not_attempted/a>/h3>div classparagraph>p>This event is emitted for SMS messages that are not sent.Reasons for an sms not being sent include:/p>/div>div classulist>ul>li>p>Sent during blackout hours/p>/li>li>p>Sent to a customer with no notification channels/p>/li>li>p>Sent to a notification channel with no consent/p>/li>li>p>Sent when 10 messages have already been sent to the customer in a 15 minute window/p>/li>li>p>Sent to a deactivated customer/p>/li>li>p>An identical message has already been sent within a 15 minute window/p>/li>/ul>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>320A93CE-F356-4379-B14B-EE01C31FB2C9/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.not_attempted/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-10-16T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1001/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9E3D8ADC-E70E-4351-B559-4805CFA4FB35/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>not_attempted/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EA637AD1-CCC3-4EF6-A3F0-CC5E25667181/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EB78F251-F773-4B03-9868-8C5F7B0C200E/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>A32DC255-24A0-4388-BBF8-42AAF42C7D12/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>The message name/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>516ED2CD-CA4E-4A0D-B5F7-44DE600F854C/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>EE9E5353-10CB-492B-8A8F-BA85AA675E87/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>392C875C-9EC0-49E3-B39A-A37434E78493/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>error_string/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>not_consented/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>error_type/span>span classdelimiter>"/span>/span>: span classinteger>1/span> }}/code>/pre>/div>/div>h4 id_event_properties_8 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification.not_attempted/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional friendly name associated with the experience trigger./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>error_string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string A description of the reason why SMS was not attempted/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>error_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>integer Numeric code 1-6 representing the failure reason./p>/div>div classolist arabic>ol classarabic>li>p>not_consented/p>/li>li>p>duplicate/p>/li>li>p>blackout_window/p>/li>li>p>no_channel_found_for_customer/p>/li>li>p>deactivated/p>/li>li>p>sms_throttle/p>/li>/ol>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification.delivered>a classlink href#notification.delivered>10.8. Event: notification.delivered/a>/h3>div classparagraph>p>This event is emitted when Relay receives confirmation, from our SMS aggregator, that the SMS message was successfully delivered to the mobile device./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.delivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>D63B8F3D-B526-47F4-BE79-B90562A7F27D/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2021-04-27T22:17:21.716Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1001/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>0488ACA1-1D46-4495-AE1C-5D67248378FC/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>delivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>B5D51B2D-2330-410D-9C0D-1864290C6026/span>span classdelimiter>"/span>/span> span classstring>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>FFFA94BA-4C1F-4009-BFFB-A9AB3DCDCAFA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F2AC5CCF-5514-4FEA-8975-A78BC072528B/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Welcome/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>B5286630-18F2-46F3-A48C-B424EFDCEBAE/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>75509C9A-FCCE-43A6-B3AC-EA8FECD90230/span>span classdelimiter>"/span>/span>, }}/code>/pre>/div>/div>h4 id_event_properties_9 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification.delivered/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification.undelivered>a classlink href#notification.undelivered>10.9. Event: notification.undelivered/a>/h3>div classparagraph>p>This event is emitted when Relay receives confirmation, from our SMS aggregator, that the SMS message was strong>not/strong> delivered to the mobile device./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.undelivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>D63B8F3D-B526-47F4-BE79-B90562A7F27D/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2021-04-27T22:17:21.716Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1001/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>B449F583-D87A-4B95-B54F-6549F41FDE2F/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>67B14764-713E-420E-8785-379F38E1656B/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>FFFA94BA-4C1F-4009-BFFB-A9AB3DCDCAFA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F2AC5CCF-5514-4FEA-8975-A78BC072528B/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Welcome/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>B5286630-18F2-46F3-A48C-B424EFDCEBAE/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>75509C9A-FCCE-43A6-B3AC-EA8FECD90230/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>undelivered/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>h4 id_event_properties_10 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification.undelivered/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification_channel.add>a classlink href#notification_channel.add>10.10. Event: notification_channel.add/a>/h3>div classparagraph>p>This event is emitted when a notification channel is added to a customer account./p>/div>div classimageblock>div classcontent>img srcimages/webhook-event-nofitication-channel-add.png altwebhook event nofitication channel add>/div>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ip-10-0-0-212-1460-1470-72d7a3f2-afa4-4452-a674-9b8eaf3fc9bb-78r/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2022-03-29T10:06:47.583Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>source_channel/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onboarding-api/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11058559276/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>add-a-phone/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_source/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>relay_network/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification_channel/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>express/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>661a8f53-220d-4456-948d-4a545f4e9ad0/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>add/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification_channel.add/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_event_properties_11 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>source_channel/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the source where the event originated from./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_source/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the secondary source where the event originated from. This value can be passed in during a phone add process by Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>consent_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the current consent for the Customer./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer currently does not have any consent. No SMS messages will be sent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer currently has express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer currently has written consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification_channel.add/code>/p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification_channel.remove>a classlink href#notification_channel.remove>10.11. Event: notification_channel.remove/a>/h3>div classparagraph>p>This event is emitted when a notification channel is removed from a customer account./p>/div>div classimageblock>div classcontent>img srcimages/webhook-event-account-deactivate-flow.png altwebhook event account deactivate flow>/div>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>ip-10-0-0-212-1460-14gq-5933015c-6bf3-4550-bb3f-fbf9dc77c1c3-1cah/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2022-03-29T10:06:48.954Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>source_channel/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>file/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>11058559276/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>remove-a-phone/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_source/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>neustar/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>relay_network/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification_channel/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classpredefined-constant>null/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1747bce1-cca2-4a1f-bbd0-a964fded3045/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>remove/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification_channel.remove/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_event_properties_12 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>source_channel/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the source where the event originated from./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_source/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the secondary source where the event originated from. This value can be passed in during a phone add process by Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>consent_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the current consent for the Customer./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer currently does not have any consent. No SMS messages will be sent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer currently has express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer currently has written consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification_channel.remove/code>/p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idnotification.auth_link_used>a classlink href#notification.auth_link_used>10.12. Event: notification.auth_link_used/a>/h3>div classparagraph>p>This event is emitted when a user clicks an code>auth_link/code>, and navigates to the related message in the em>Feed/em>./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>If the user clicks an code>auth_link/code> and is taken to a verification page or passcode page and the user does not complete that action, this event will not be emitted. This event is only emitted when the user views the actual message (related to the code>auth_link/code>) in the Feed./td>/tr>/table>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>568C69C9-702D-478B-BC00-923C3F9F3BDD/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>notification.auth_link_used/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-01-01T12:00:00.000Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1000-aa-13CE/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>10005551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9006E214-5261-4736-9192-B0ADD3005723/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>A689672A-0A6E-4E99-8C5D-1CAD3728CA32/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>44BE6B5D-26B1-40EA-9750-2E8C82067AF6/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>3AE05D87-B00E-42E7-9D68-C16C73B68162/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>nickname/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8BD6EBD9-94F4-4746-82DA-542E98D86823/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>99999999-8888-7777-6666-555555555555/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>F9564106-C25A-4FD2-A9DF-F26ADC1D1362/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>h4 id_event_properties_13 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>notification.auth_link_used/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Contains the channel address.The value and format will be different based on the code>channel_type/code> value.The value is optional and may be set to code>null/code>./p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>11 digit mobile number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>job_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Internal unique job identifier of the originating event. This field is optional and may not always be set./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The name of the message that was set in the CXB./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idpowerups_data.received>a classlink href#powerups_data.received>10.13. Event: powerups_data.received/a>/h3>div classparagraph>p>This event is emitted when Relay receives a submitted customer response to a Power-Ups prompt./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>321B76GR-F251-1234-C15D-EF11C31FB2C4/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>powerups_data.received/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2021-09-27T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1232242102/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>f3370e02-cbca-4e96-8b3b-b00704fc48f3/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9b096947-e604-48ec-9808-705bbb16cd66/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>73936fa9-7616-4d27-a45a-16258f5d7bdb/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>d1aa0fda-fa83-48d5-91d5-30f9fcf6a9c4/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>form_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>form::f5992138-bf55-53c0-b3d9-be8193b1cf91/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_submitted_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1631888918000/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>relay_tracking_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9b034851-e406-84ec-9808-705bbb16cd66/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_message_tag/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Test message tag/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>bonjour/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>secondary_account_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9348234823723/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>submission_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>852b8361-1edf-5279-85c3-03c9fae8c879/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>submission/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>answer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>name_first/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>name-first/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Testing/span>span classdelimiter>"/span>/span> }, { span classkey>span classdelimiter>"/span>span classcontent>answer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>name_last/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>name-last/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Hello/span>span classdelimiter>"/span>/span> }, { span classkey>span classdelimiter>"/span>span classcontent>answer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>email4/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>email/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>testemail@relaynetwork.com/span>span classdelimiter>"/span>/span> } }}/code>/pre>/div>/div>h4 id_event_properties_14 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>powerups_data.received/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>form_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the form filled out by the customer/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>date_submitted_at/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The timestamp of when the customer submitted their answers in unix ms format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, tag that was provided during the initial messaging/onboarding request./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>secondary_account_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Optional. This field can be used to tie the em>Customer/em> back to another external system/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>submission_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Power-Ups submission./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>submission/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>array Contains a list of customer answers to questions asked by the Power-Ups form. Each answer will be an object type and will contain the following properties:/p>/div>div classhdlist>table>tr>td classhdlist1>answer_id/td>td classhdlist2>p>string Identifier of answer, maps to question id/p>/td>/tr>tr>td classhdlist1>type/td>td classhdlist2>p>string Question/answer type/p>/td>/tr>tr>td classhdlist1>value/td>td classhdlist2>p>string Customer answer to question/p>/td>/tr>/table>/div>/div>/td>/tr>/tbody>/table>/div>div classsect2>h3 idtext_message.received>a classlink href#text_message.received>10.14. Event: text_message.received/a>/h3>div classparagraph>p>This event is emitted when Relay receives an SMS message from our aggregator with the contents of the text message obtained from the carrier originating from the mobile device./p>/div>div classlistingblock>div classtitle>Example Event Object/div>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>event_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>68EB7899-28D1-4546-9F97-F6E76EE9C184/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>text_message.received/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_ts/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2018-10-16T13:08:00.745Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>payload/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>event_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>text_message/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>event_subtype/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>received/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1ffdca03-714e-4280-8681-3d3a33f38043/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>onelifehealth/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>9999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>97s34a57-2816-489a-b78c-a4310abf232b/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8BD6EBD9-94F4-4746-82DA-542E98D86823/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>8945B43E-A68E-434C-B5F1-FAC1A5731B0C/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_trigger_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>bonjour/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>a2w_mo_ref_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>255890070920/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>carrier/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>tmobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>device_address/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>15202489722/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>inbound_address/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>73529/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Stop all/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_orig/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Stop all/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>h4 id_event_properties_15 classdiscrete>Event Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 24%;>col stylewidth: 76%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>event_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID This is a unique Relay identifier used for tracking./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>code>text_message.received/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_ts/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>timestamp Contains the date and time of when the event occurred. The data is in a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a> format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>relay_tracking_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An internal Relay identifier for the event. This value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>payload/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains additional properties that are specific to the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the main event type category. This field contains the value left of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>event_subtype/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the subtype of the event. This field contains the value right of the code>./code> from the code>event_name/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Client./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ccid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique identifier of the Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Journey identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique, internal, identifier associated with the source notification.The value is optional and may be set to code>null/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The current product group identifier of the Customer. An account is associated to one and only one product group at a time./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The unique Trigger identifier that was the originating source of the event./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string An optional, Client provided, trigger id value./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a2w_mo_ref_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string A unique system generated message ID./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>carrier/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The carrier associated with the mobile number (i.e., Verizon, T-mobile, and AT&T, etc.)/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Identifies the channel type of the code>channel_addr/code> field.The value is optional and may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>Channel target is an SMS notification/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>country_code/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The country code associated with the mobile number. E.g. ‘1’ for US mobile numbers, ’44’ for UK, etc./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>device_address/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The mobile number of the text sender (i.e, a customer or patient) received from the carrier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>inbound_address/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The address field received from the carrier (normally a short code or sender id) to which the text sender is responding./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string Filtered version of the original message body or content of the text. The system filters out certain matching regular expressions from MOs, such as: “Re:”, “In Reply To.”, “-----Original Message-----“, etc. as these prefixes may be automatically inserted by the end-user’s device to mobile originated messages./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_orig/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string The message body or content of the text as originally sent by the customer or patient from their mobile device./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>/div>h1 id_csv_file_processing classsect0>a classlink href#_csv_file_processing>CSV File Processing/a>/h1>div classsect1>h2 idcsv-file-format>a classlink href#csv-file-format>11. CSV File Format Rules/a>/h2>div classsectionbody>div classsidebarblock>div classcontent>div classparagraph>p>CSV stands for em>Comma-separated values/em> and is a format for storing tabular data in a plain text file./p>/div>div classparagraph>p>See: a hrefhttps://en.wikipedia.org/wiki/Comma-separated_values>Wikipedia Comma-separated values/a>/p>/div>/div>/div>div classparagraph>p>The first row in a CSV file lists the field names for the object that you’re processing. Each subsequent row corresponds to a separate record.A record consists of a series of fields that are delimited by commas. A CSV file can contain multiple records and constitutes a batch.All the records in a CSV file must be for the same object./p>/div>h3 id_csv_file_rules classdiscrete>CSV File Rules/h3>h4 id_general classdiscrete>General/h4>div classulist>ul>li>p>Files must be in UTF-8 format/p>/li>li>p>The field delimiter must be a em>comma/em>/p>/li>li>p>The line delimiter can either be CRLF (Windows format) or LF (Linux format)/p>/li>/ul>/div>h4 id_header_first_row classdiscrete>Header (first) Row/h4>div classulist>ul>li>p>Field names are case insensitive/p>/li>li>p>Only required field names are required to be present in the em>Header/em> row/p>/li>li>p>The order of the fields in the em>Header/em> row does not matter/p>/li>/ul>/div>h4 id_data_rows classdiscrete>Data Rows/h4>div classulist>ul>li>p>A required field must contain a value in each data row/p>/li>li>p>The order of the fields in the data row must match the order the fields were specified in the em>header/em> row/p>/li>li>p>If an em>optional/em> field was specified in the em>header/em> row, then it must be accounted for in the data row. However, its value is optional and can be left blank./p>/li>li>p>If a field value contains a comma, then the field value must be contained within double quotes./p>/li>/ul>/div>div classexampleblock>div classtitle>Example 1. Example CSV field value containing a comma character/div>div classcontent>code>VP of DevOps, Eastern Region/code>/div>/div>div classulist>ul>li>p>If a field value contains a double quote, then the double quote must be escaped by preceding it with another double quote./p>/li>/ul>/div>div classexampleblock>div classtitle>Example 2. Example CSV field value containing a double quote character/div>div classcontent>code>This is the gold standard/code>/div>/div>div classulist>ul>li>p>All fields are trimmed of leading and trailing spaces/p>/li>li>p>New lines are not supported inside a field value/p>/li>/ul>/div>/div>/div>div classsect1>h2 id_csv_file_types>a classlink href#_csv_file_types>12. CSV File Types/a>/h2>div classsectionbody>div classsect2>h3 idcca-csv-file-format>a classlink href#cca-csv-file-format>12.1. CCA CSV File/a>/h3>div classparagraph>p>The em>Client Customer Account/em> (CCA) file is used to populate the Relay system with valid em>Customer/em> records. These records are used to validate a em>Customer/em> when they are onboarded via any enabled onboarding channel./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PRODUCT_GROUP/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Identifies the em>Product Group/em> the em>Customer/em> will be assigned to. The em>Customer/em> can only be assigned to one em>Product Group/em>./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>SECONDARY_ACCOUNT_ID/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This field can be used to tie the em>Customer/em> back to another external system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>FIRST_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the first name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>MIDDLE_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the middle name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LAST_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the last name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ADDRESS1/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the first line of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ADDRESS2/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the second line of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CITY/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies city of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>STATE_PROVINCE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies state or province of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>POSTAL_CODE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies postal code of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>COUNTRY/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies country of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>DATE_OF_BIRTH/p>/td>td classtableblock halign-left valign-top>p classtableblock>date/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the date of birth of the em>Customer/em>./p>p classtableblock>Format: yyyy-mm-dd/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>SSN_LAST4/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(4)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the last 4 digits of the em>Customer/em> social security number./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>GENDER/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(1)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. Identifies the gender of the em>Customer/em>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>EXT_xxx/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined, extensible properties to be stored with the em>Customer/em> record. Each extensible property must be prefixedwith code>EXT_/code>./p>/div>div classulist>ul>li>p>Custom code>EXT_/code> properties are provided by the Client/p>/li>li>p>Zero or more code>EXT_/code> properties can be provided/p>/li>li>p>Differnt code>EXT_/code> properties can be provided for each Customer/p>/li>li>p>The maximum length of each code>EXT_/code> property is 100 characters/p>/li>/ul>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_files classdiscrete>Example CSV Files/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classparagraph>div classtitle>Example CSV File without EXT_ Fields/div>p>(a hreffile-formats/sample-files/cca.csv>download sample file/a>)/p>/div>div classlistingblock>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>PRODUCT_GROUP/mark>,SECONDARY_ACCOUNT_ID,FIRST_NAME,MIDDLE_NAME,LAST_NAME,ADDRESS1,ADDRESS2,CITY,STATE_PROVINCE,POSTAL_CODE,COUNTRY,DATE_OF_BIRTH,SSN_LAST4,GENDERmark>100A67C/mark>,mark>default/mark>,,John,,Joe,100 West Main Street,,Philadelphia,PA,19087,us,1980-04-01,5555,M/code>/pre>/div>/div>div classparagraph>div classtitle>Exmple CSV File with EXT_ Fields/div>p>(a hreffile-formats/sample-files/cca-with-custom-fields.csv>download sample file/a>)/p>/div>div classlistingblock>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>PRODUCT_GROUP/mark>,SECONDARY_ACCOUNT_ID,FIRST_NAME,MIDDLE_NAME,LAST_NAME,ADDRESS1,ADDRESS2,CITY,STATE_PROVINCE,POSTAL_CODE,COUNTRY,DATE_OF_BIRTH,SSN_LAST4,GENDER,EXT_MEMBER_SINCE,EXT_BALANCEmark>100A67C/mark>,mark>default/mark>,,John,,Doe,100 West Main Street,,Philadelphia,PA,19087,us,1980-04-01,5555,M,1999-04-01,1500.00/code>/pre>/div>/div>/div>div classsect2>h3 idonboarding-csv-file-format>a classlink href#onboarding-csv-file-format>12.2. Onboarding CSV File/a>/h3>div classparagraph>p>The em>Onboarding File/em> format is used to onboard em>Customers/em> to Relay. During the onboarding process, an optional message can be sent to the em>Customer/em>. The message to be sent is identified by the code>TRIGGER_ID/code> field./p>/div>div classparagraph>p>If a em>Customer/em> is re-onboarded, then the existing em>Customer/em> data will be updated with the new data provided in the onboarding file./p>/div>div classparagraph>p>If a em>TRIGGER_ID/em> is specified and the customer has valid consent, then the Relay experience will be sent regardless if this is a new onboard or if an existing customer is being updated./p>/div>div classparagraph>p>If a em>Client/em> is has mobile analysis and strict onboarding enabled, for all phone numbers that are not considered as type code>mobile/code>, the onboarding process will include the record in the reject file, indicating that the specific number is non-mobile and was not included on the customer account./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_2 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PHONE_NUMBER/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. The phone number associated with the em>Customer/em>. This field must contain only numeric values./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PRODUCT_GROUP/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Identifies the em>Product Group/em> the em>Customer/em> will be assigned to. The em>Customer/em> can only be assigned to one em>Product Group/em>./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CONSENT_TYPE/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Required/strong>. Specifies the type of consent the em>Customer/em> has./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>written/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express written consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>TRIGGER_ID/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Trigger Identifier associated with the message to be sent to the code>CCID/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>DEACTIVATE_PREVIOUS_CONNECTIONS/p>/td>td classtableblock halign-left valign-top>p classtableblock>boolean/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. This processing flag is used to control how existing connections, for an existing em>Customer/em>, should be treated./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>This field is only available when using version 3.5 or greater of the File Engine/td>/tr>/table>/div>div classhdlist>table>tr>td classhdlist1>true/td>td classhdlist2>p>All existing connections will be removed prior to onboarding the new data/p>/td>/tr>tr>td classhdlist1>false/td>td classhdlist2>p>Existing connections will not be removed prior to onboarding. If onboarding with a new mobile number it will be added to the list of existing connections./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>SECONDARY_ACCOUNT_ID/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. This field can be used to tie the em>Customer/em> back to another external system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>FIRST_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the first name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>MIDDLE_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the middle name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LAST_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the last name of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>PHONE_TYPE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. Identifies the type of phone number provided. Must be one of the following values:/p>/div>div classhdlist>table>tr>td classhdlist1>mobile/td>td classhdlist2>p>The phone number provided is a mobile number/p>/td>/tr>tr>td classhdlist1>landline/td>td classhdlist2>p>The phone number provided is for a land line/p>/td>/tr>tr>td classhdlist1>unknown/td>td classhdlist2>p>The phone type is unknown/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>COUNTRY_CODE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(3)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. The country code associated with the em>Customer/em> phone number/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>EMAIL_ADDRESS/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. The email address of the em>Customer/em>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ADDRESS1/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the first line of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ADDRESS2/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the second line of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CITY/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies city of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>STATE_PROVINCE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies state or province of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>POSTAL_CODE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies postal code of the em>Customer/em> address/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>COUNTRY/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies country of the em>Customer/em> address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>DATE_OF_BIRTH/p>/td>td classtableblock halign-left valign-top>p classtableblock>date/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Identifies the date of birth of the em>Customer/em>./p>p classtableblock>Format: yyyy-mm-dd/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>SSN_LAST4/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(4)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional. Contains the last 4 digits of the em>Customer/em> social security number./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>GENDER/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(1)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. Identifies the gender of the em>Customer/em>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>EXT_xxx/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined, extensible properties to be stored with the em>Customer/em> record. Each extensible property must be prefixedwith code>EXT_/code>./p>/div>div classulist>ul>li>p>Custom code>EXT_/code> properties are provided by the Client/p>/li>li>p>Zero or more code>EXT_/code> properties can be provided/p>/li>li>p>Differnt code>EXT_/code> properties can be provided for each Customer/p>/li>li>p>The maximum length of each code>EXT_/code> property is 100 characters/p>/li>/ul>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>INPUT_xxx/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional input parameters to the message. Each input parameter is prefixed with em>INPUT_/em> followed by the input parameter name./p>/div>div classulist>ul>li>p>Custom input parameters are provided by the Client/p>/li>li>p>Zero or more code>INPUT_/code> parameters can be specified/p>/li>li>p>Different code>INPUT_/code> parameters can be specified on each row in the file/p>/li>li>p>The maximum length of each code>INPUT_/code> parameter is 100 characters/p>/li>/ul>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CLIENT_MESSAGE_TAG/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LB_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined property to store the em>Launched_by Name/em> record. Identifies the individual who launched a certain journey/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LB_SOURCE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined property to store the em>Launched_by Source/em> record. Identifies the system where a journey was launched./p>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_files_2 classdiscrete>Example CSV Files/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File - Without custom INPUT_ or EXT_ columns (a hreffile-formats/sample-files/onboarding.csv>download sample file/a>)/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>PHONE_NUMBER/mark>,mark>PRODUCT_GROUP/mark>,mark>CONSENT_TYPE/mark>,TRIGGER_ID,SECONDARY_ACCOUNT_ID,FIRST_NAME,MIDDLE_NAME,LAST_NAME,PHONE_TYPE,COUNTRY_CODE,EMAIL_ADDRESS,ADDRESS1,ADDRESS2,CITY,STATE_PROVINCE,POSTAL_CODE,COUNTRY,DATE_OF_BIRTH,SSN_LAST4,GENDER,CLIENT_MESSAGE_TAG,LB_NAME,LB_SOURCEmark>100A67C/mark>,mark>2155555555/mark>,mark>DEFAULT/mark>,mark>written/mark>,148bc48f-32dc-4fa5-95a6-f01a42f5e36e,,John,,Smith,mobile,1,jsmith@acme.org,10 W. Main Street,,Media,PA,19034,us,1980-04-01,5555,M,optional pass-through,user@company.com,company-system/code>/pre>/div>/div>div classlistingblock>div classtitle>Example CSV File - With example custom INPUT_ and EXT_ columns (a hreffile-formats/sample-files/onboarding-with-input-and-ext.csv>download sample file/a>)/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>PHONE_NUMBER/mark>,mark>PRODUCT_GROUP/mark>,mark>CONSENT_TYPE/mark>,TRIGGER_ID,SECONDARY_ACCOUNT_ID,FIRST_NAME,MIDDLE_NAME,LAST_NAME,PHONE_TYPE,COUNTRY_CODE,EMAIL_ADDRESS,ADDRESS1,ADDRESS2,CITY,STATE_PROVINCE,POSTAL_CODE,COUNTRY,DATE_OF_BIRTH,SSN_LAST4,GENDER,INPUT_AGE,EXT_MEMBER_SINCE,EXT_SERVICE_LEVEL,CLIENT_MESSAGE_TAG,LB_NAME,LB_SOURCEmark>100A67C/mark>,mark>2155555555/mark>,mark>DEFAULT/mark>,mark>written/mark>,148bc48f-32dc-4fa5-95a6-f01a42f5e36e,,John,,Smith,mobile,1,jsmith@acme.org,10 W. Main Street,,Media,PA,19034,us,1980-04-01,5555,M,40,2015-03-09,GOLD,optional pass-through,user@company.com,company-system/code>/pre>/div>/div>/div>div classsect2>h3 idmessaging-csv-file-format>a classlink href#messaging-csv-file-format>12.3. Messaging CSV File/a>/h3>div classparagraph>p>The em>Messaging File/em> format is used to trigger a message to one or more em>Customers/em>, identified by the code>CCID/code> field.Each row in the CSV file identifies a single code>CCID/code> and code>TRIGGER_ID/code> combination. Each row can specify a different code>TRIGGER_ID/code> from a different journey./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_3 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>TRIGGER_ID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Trigger Identifier associated with the message to be sent to the code>CCID/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ASSET_ID/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional asset id. The asset id can be used to override the default branding on the message./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>INPUT_xxx/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional input parameters to the message. Each input parameter is prefixed with em>INPUT_/em> followed by the input parameter name./p>/div>div classulist>ul>li>p>Custom input parameters are provided by the Client/p>/li>li>p>Zero or more code>INPUT_/code> parameters can be specified/p>/li>li>p>Different code>INPUT_/code> parameters can be specified on each row in the file/p>/li>li>p>The maximum length of each code>INPUT_/code> parameter is 100 characters/p>/li>/ul>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CLIENT_MESSAGE_TAG/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LB_NAME/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined property to store the em>Launched_by Name/em> record. Identifies the individual who launched a certain journey/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>LB_SOURCE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional, Client defined property to store the em>Launched_by Source/em> record. Identifies the system where a journey was launched./p>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_files_3 classdiscrete>Example CSV Files/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File - Without custom input parameters ( a hreffile-formats/sample-files/messaging.csv>download sample file/a> )/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>TRIGGER_ID/mark>,ASSET_ID,CLIENT_MESSAGE_TAG,LB_NAME,LB_SOURCEmark>100A67C/mark>,mark>148bc48f-32dc-4fa5-95a6-f01a42f5e36e/mark>,gold-plan-image,optional pass-through,user@company.com,company-system/code>/pre>/div>/div>div classlistingblock>div classtitle>Example CSV File - With example custom input parameters ( a hreffile-formats/sample-files/messaging-with-custom-fields.csv>download sample file/a> )/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>TRIGGER_ID/mark>,ASSET_ID,INPUT_SERVICE_PLAN,INPUT_MEMBER_SINCE,CLIENT_MESSAGE_TAG,LB_NAME,LB_SOURCEmark>100A67C/mark>,mark>148bc48f-32dc-4fa5-95a6-f01a42f5e36e/mark>,gold-plan-image,gold,2015-03-09,optional pass-through,user@company.com,company-system/code>/pre>/div>/div>/div>div classsect2>h3 idmessaging-portal-csv-file-format>a classlink href#messaging-portal-csv-file-format>12.4. CXB Message File Upload/a>/h3>div classparagraph>p>This em>Messaging File/em> format is used when uploading the file from the CXB web application./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_4 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ASSET_ID/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional asset id. The asset id can be used to override the default branding on the message./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>INPUT_xxx/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional input parameters to the message. Each input parameter is prefixed with em>INPUT_/em> followed by the input parameter name./p>/div>div classulist>ul>li>p>Custom input parameters are provided by the Client/p>/li>li>p>Zero or more code>INPUT_/code> parameters can be specified/p>/li>li>p>Different code>INPUT_/code> parameters can be specified on each row in the file/p>/li>li>p>The maximum length of each code>INPUT_/code> parameter is 100 characters/p>/li>/ul>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_files_4 classdiscrete>Example CSV Files/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File - Without custom input parameters (a hreffile-formats/sample-files/messaging-client-portal.csv>download sample file/a>)/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,ASSET_IDmark>100A67C/mark>,gold-plan-image/code>/pre>/div>/div>div classlistingblock>div classtitle>Example CSV File - With example custom input parameters (a hreffile-formats/sample-files/messaging-client-portal-with-custom-fields.csv>download sample file/a>)/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,ASSET_ID,INPUT_SERVICE_PLAN,INPUT_MEMBER_SINCEmark>100A67C/mark>,gold-plan-image,gold,2015-03-09/code>/pre>/div>/div>/div>div classsect2>h3 idmobile-analysis-csv-file-format>a classlink href#mobile-analysis-csv-file-format>12.5. Mobile Analysis CSV File/a>/h3>div classparagraph>p>The em>Mobile Analysis File/em> format is used to determine if a phone mumber is associated with mobile phone or not. Each row identifies a single phone number for analysis./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_5 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PHONE_NUMBER/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. The phone number to run mobile analysis against. This field must contain only numeric values./p>/td>/tr>/tbody>/table>h4 id_example_csv_file classdiscrete>Example CSV File/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>PHONE_NUMBER/mark>mark>0005559999/mark>/code>/pre>/div>/div>/div>div classsect2>h3 idconsent-update-csv-file-format>a classlink href#consent-update-csv-file-format>12.6. Consent Update CSV File/a>/h3>div classparagraph>p>The em>Consent Update File/em> format is used to update the consent of a specific phone number. Consent is always to a phone number. This is because a em>Customer/em> may have multiple phone numbers (think families) and the em>Customer/em> has only granted consent to receive messages on one (or more) specific mobile phone numbers./p>/div>div classparagraph>p>Each row in the file identifies a single code>PHONE_NUMBER/code>./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_6 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PHONE_NUMBER/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. The phone number associated with the em>Customer/em>. This field must contain only numeric values./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CONSENT_TYPE/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Required/strong>. Specifies the type of consent the em>Customer/em> has./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>written/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express written consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express consent./p>/td>/tr>/table>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_file_2 classdiscrete>Example CSV File/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>PHONE_NUMBER/mark>,mark>CONSENT_TYPE/mark>mark>2223334444/mark>,mark>written/mark>mark>2223335555/mark>,mark>stop/mark>mark>2223336666/mark>,mark>express/mark>/code>/pre>/div>/div>/div>div classsect2>h3 idphone-management-csv-file-format>a classlink href#phone-management-csv-file-format>12.7. Phone Management CSV File/a>/h3>div classparagraph>p>The em>Phone Management File/em> format is used to add or remove phone number to client customers, identified by the code>CCID/code> column.Each row identifies a single code>CCID/code>./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_7 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>PHONE_NUMBER/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. The phone number associated with the em>Customer/em>. This field must contain only numeric values./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ACTION/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Required/strong>. Identifies the phone management action to take./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>add/td>td classhdlist2>p>Add the phone number to the em>Customer/em> identified by the code>CCID/code> field.br>strong>The code>CONSENT_TYPE/code> field is required when the action is code>ADD/code>/strong>./p>/td>/tr>tr>td classhdlist1>remove/td>td classhdlist2>p>Remove the phone number from the em>Customer/em> identified by the code>CCID/code> field./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CONSENT_TYPE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. Specifies the type of consent assigned to the code>PHONE_NUMBER/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>written/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express written consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have express consent./p>/td>/tr>tr>td classhdlist1>stop/td>td classhdlist2>p>The code>PHONE_NUMBER/code> will have stop consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CLIENT_SOURCE/p>/td>td classtableblock halign-left valign-top>p classtableblock>string/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. Specifies a value for a custom source for the phone management record./p>/div>/div>/td>/tr>/tbody>/table>h4 id_example_csv_file_3 classdiscrete>Example CSV File/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>,mark>PHONE_NUMBER/mark>,mark>ACTION/mark>,CONSENT_TYPE,CLIENT_SOURCEmark>100A67C/mark>,mark>2223334444/mark>,mark>add/mark>,mark>written/mark>mark>984E45D/mark>,mark>2223334445/mark>,mark>remove/mark>,mark>foo/mark>,mark>1111111111/mark>,mark>remove/mark>,,Neustarmark>bar/mark>,mark>1111111112/mark>,mark>add/mark>,mark>express/mark>,custom client source/code>/pre>/div>/div>/div>div classsect2>h3 iddeactivation-csv-file-format>a classlink href#deactivation-csv-file-format>12.8. Deactivation CSV File/a>/h3>div classparagraph>p>The em>Deactivation File/em> format is used to deactivate em>Customers/em>, identified by the code>CCID/code> column. Each row identifies a single em>Customer/em> to be deactivated./p>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Refer to a href#csv-file-format>CSV File Format Rules/a> for specifics on how to create and format a CSV file./td>/tr>/table>/div>h4 id_data_fields_8 classdiscrete>Data Fields/h4>div classparagraph>p>All required properties are in strong>bold/strong>./p>/div>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 10%;>col stylewidth: 70%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Uniquely identifies the em>Customer/em> within the Relay system/p>/td>/tr>/tbody>/table>h4 id_example_csv_file_4 classdiscrete>Example CSV File/h4>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Required fields are mark>highlighted/mark>/td>/tr>/table>/div>div classlistingblock>div classtitle>Example CSV File/div>div classcontent>pre classCodeRay highlight nowrap>code data-langplain>mark>CCID/mark>mark>100A67C/mark>mark>984E45D/mark>/code>/pre>/div>/div>h4 id_error_codes classdiscrete>Error Codes/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 20%;>col stylewidth: 80%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Error/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>CCID_MAX_LENGTH/p>/td>td classtableblock halign-left valign-top>p classtableblock>The CCID field is longer than 100 characters/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CCID_ILLEGAL_CHARACTER/p>/td>td classtableblock halign-left valign-top>p classtableblock>The CCID field contains a tab character/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>CCID_NOT_NULL/p>/td>td classtableblock halign-left valign-top>p classtableblock>The CCID field is not set/p>/td>/tr>/tbody>/table>/div>/div>/div>h1 id_standard_reports classsect0>a classlink href#_standard_reports>Standard Reports/a>/h1>div classsect1>h2 id_connection_events_report>a classlink href#_connection_events_report>13. Connection Events Report/a>/h2>div classsectionbody>h3 idconnection-event-reports classdiscrete>Purpose/h3>div classparagraph>p>A flat file option for ingesting connection events. Clients not requiring real time event sync OR Clients limited by technology resources are able to ingest the Connection Events Report and receive the same level of detail as the Push API. This report is available in both Staging and Production Environments./p>/div>h3 id_included_events classdiscrete>Included Events/h3>div classulist>ul>li>p>code>channel_consent.update/code>/p>/li>li>p>code>notification_channel.add/code>/p>/li>li>p>code>notification_channel.remove/code>/p>/li>li>p>code>account.deactivate/code>/p>/li>li>p>code>mobile_analysis.rejected/code>/p>/li>/ul>/div>h3 id_expected_frequency classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>div classparagraph>p>Clients may request the frequency be increased 4x a day. In these cases, reports will run with a 1 hour offset, meaning a 6am report will include data from 11pm the prior day to 5am the day of the report. To account for the potential for data delays to the DW in excess of 1 hour, a daily report will be issued in addition to the 4x daily reports./p>/div>h3 id_event_properties_16 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Client ID/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. A unique client identifier provided by Relay./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. Uniquely identifies a Client’s Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>First Name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s First Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Last Name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s Last Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Type/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The event type. Values include code>notification_channel/code>, code>channel_consent/code>, code>mobile_analysis_onboarding/code> and code>account/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Subtype/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The sub event type. Values include code>add/code>, code>remove/code>, code>update/code>, code>rejected/code>, and code>deactivate/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Timestamp/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong> timestamp. Contains the date and time when the event occurred. The data is in ISO 8601 format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Product Group ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The product group Id assigned to the CCID. A CCID can only be assigned to a single product group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Channel Address/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The phone number associated with the Customer. Example: code>12155551234/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Current Consent/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (50)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The current consent type for the channel address./p>/div>div classparagraph>p>Valid values:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer currently does not have any consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer currently has express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer currently has written consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Previous Consent/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (50)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The previous consent type for the channel address. The value may be set to code>null/code>./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>stop/td>td classhdlist2>p>The Customer previously did not have any consent./p>/td>/tr>tr>td classhdlist1>express/td>td classhdlist2>p>The Customer previously had express consent./p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The Customer previously had written consent./p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Source Channel/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The source channel where the event originated from. Examples: code>onboarding-api/code>, code>api/code>, code>add-phone.api/code>, code>phone-management-add.file/code>, code>csr/code>, code>ivr/code>, code>sign-up-page/code>, code>file/code>, code>onboarding.file/code>, code>sms_conversation/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Secondary Source/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>A second level of tracking the source of an update or onboard request. Example: phone number removals occurring as a part of monthly Neustar analysis will have a client_source of “Neustar.”/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Event ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique Relay event identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Custom Data/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string(1000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>If custom data is desired, this field will be added to include ext fields from dim_customer table./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>div classsect1>h2 id_experience_events_report>a classlink href#_experience_events_report>14. Experience Events Report/a>/h2>div classsectionbody>h3 idexperience-event-reports classdiscrete>Purpose/h3>div classparagraph>p>A flat file option for ingesting experience events. Clients not requiring real time event sync OR Clients limited by technology resources are able to ingest the Experience Events Report and receive the same level of detail as the Push API. This report is available in both Staging and Production Environments./p>/div>h3 id_included_events_2 classdiscrete>Included Events/h3>div classulist>ul>li>p>code>message.action_taken/code>/p>/li>li>p>code>notification.attempted/code>/p>/li>li>p>code>notification.delivered/code>/p>/li>li>p>code>notification.undelivered/code>/p>/li>li>p>code>notification.auth_link_used/code>/p>/li>li>p>code>message.undelivered/code>/p>/li>li>p>code>notification.not_attempted/code> (except when reason blackout_window)/p>/li>/ul>/div>h3 id_expected_frequency_2 classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>div classparagraph>p>Clients may request the frequency be increased 4x a day. In these cases, reports will run with a 1 hour offset, meaning a 6am report will include data from 11pm the prior day to 5am the day of the report. To account for the potential for data delays to the DW in excess of 1 hour, a daily report will be issued in addition to the 4x daily reports./p>/div>h3 id_event_properties_17 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Client ID/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. A unique client identifier provided by Relay./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Type/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The event type. Values include code>notification/code> and code>message/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Subtype/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The sub event type. Values include code>delivered/code>, code>undelivered/code>, code>action_taken/code>, code>auth_link_used/code>, code>attempted/code>, and code>not_attempted/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Event Timestamp/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong> timestamp. Contains the date and time when the event occurred. The data is in ISO 8601 format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>CCID/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. Uniquely identifies a Client’s Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Product Group ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The product group Id assigned to the CCID. A CCID can only be assigned to a single product group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Channel Address/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The phone number associated with the Customer. Example: code>12155551234/code>/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Client Message Tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>A system passthrough value intended to link triggered experiences to other Client systems./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Outcome/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The outcome assigned to the feed message./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Experience Type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The experience type assigned to the feed message./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Experience Name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The name given to a collection of messages. An organizational name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Trigger Name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The user friendly name associated with the Relay experience trigger./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Message Name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The CX Builder entered name of the feed message./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Action Label/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The text on an action element within a feed experience. Examples: code>Call Customer Service/code> and code>Provide Feedback/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Action Value/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The destination of an action. Examples: code>(800) 555 1234/code> and code>feedback@relaynetwork.com/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Is Resent Auth Link?/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Boolean/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Is this a new auth link to an existing message? code>TRUE/code> or code>FALSE/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Error Type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The result code or the short error description./p>/div>div classparagraph>p>Values include: code>1/code>, code>2/code>, code>4/code>, code>5/code>, code>6/code>, code>missing-fields/code>, code>duplicate-request/code>, code>trigger-not-found/code>, code>ccid-not-found/code>, code>40/code>, code>200/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Error Description/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The description of the result code or a detailed description including ids./p>/div>div classparagraph>p>Values include: code>not_consented/code>, code>duplicate/code>, code>no-channel-found-for-customer/code>, code>deactivated/code>, code>sms_throttle/code>, code>missing input parameters: account_fieldname1/code>, code>missing input parameters: input_fieldname2/code>, code>Duplicate message suppression is active/code>, code>No journey found for trigger_id client_trigger_id/trigger_id/code>, code>Customer id ccid not found/code>, code>Carrier has accepted the message for delivery/code>, code>Carrier Success/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Launched By/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The name of the person or system that triggered the experience to the customer. This value can be passed in at time of trigger OR system default values may be used./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Journey ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique Relay experience identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Trigger ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The trigger Id of the Relay experience the event is related to./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Message ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The unique, internal Relay feed message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Notification ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique Relay notification identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Event ID/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique Relay event identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Custom Data/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (1000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>If custom data is desired, this field will be added to include ext fields from dim_customer table./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>div classsect1>h2 id_two_way_conversation_report>a classlink href#_two_way_conversation_report>15. Two-way Conversation Report/a>/h2>div classsectionbody>h3 idtwo-way-conversation-reports classdiscrete>Purpose/h3>div classparagraph>p>A flat file option for ingesting two-way activity over a specified time. This report is available only in the Production Environment./p>/div>h3 id_included_events_3 classdiscrete>Included Events/h3>div classulist>ul>li>p>code>twoway.agent_ping/code>/p>/li>li>p>code>twoway_webhook.customer_message_sent/code>/p>/li>li>p>code>twoway.channel_closed/code>/p>/li>li>p>code>twoway_webhook.agent_message_sent/code>/p>/li>li>p>code>twoway_webhook.system_message_sent/code>/p>/li>/ul>/div>h3 id_expected_frequency_3 classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>div classparagraph>p>Clients may request the frequency be changed to weekly or monthly. Monthly reports are generated on the first weekend of each month or the following weekend./p>/div>h3 id_event_properties_18 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>user_email/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>E-mail address of the CXB User./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_first_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s First Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_last_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Last Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_roles/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>varchar (1024)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Role. The two roles (if available) in CX builder for both Two way messaging and CXB Access./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_control_group/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Assigned Control Group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (225)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. Uniquely identifies a Client’s Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>first_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s First Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>last_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s Last Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The product group Id assigned to the CCID. A CCID can only be assigned to a single product group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>communication_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Possible values are cxb user send, two way user send, autobot send, two way close, and two way ping./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>event_time/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong> timestamp. Contains the date and time when the event occurred. The data is in ISO 8601 format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>control_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Control tag is an attribute of the two way channel, and is used to control CXB Users view of messages./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>twoway_channel_sid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Unique Identifier of the Two-way Channel./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>twoway_body/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>varchar (5000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Conversational text between CXB User and Customer, may be empty depending on the Communication Type./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>div classsect1>h2 id_two_way_activity_report>a classlink href#_two_way_activity_report>16. Two-way Activity Report/a>/h2>div classsectionbody>h3 idtwo-way-activity-reports classdiscrete>Purpose/h3>div classparagraph>p>A flat file option for ingesting two-way activity, excluding the actual two-way conversation text, over a specified time. This report is available only in the Production Environment./p>/div>h3 id_included_events_4 classdiscrete>Included Events/h3>div classulist>ul>li>p>code>twoway.agent_ping/code>/p>/li>li>p>code>twoway_webhook.customer_message_sent/code>/p>/li>li>p>code>twoway.channel_closed/code>/p>/li>li>p>code>twoway_webhook.agent_message_sent/code>/p>/li>li>p>code>twoway_webhook.system_message_sent/code>/p>/li>/ul>/div>h3 id_expected_frequency_4 classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>div classparagraph>p>Clients may request the frequency be changed to weekly or monthly. Monthly reports are generated on the first weekend of each month or the following weekend./p>/div>h3 id_event_properties_19 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>user_email/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>E-mail address of the CXB User./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_first_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s First Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_last_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Last Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_roles/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>varchar (1024)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Role. The two roles (if available) in CX builder for both Two way messaging and CXB Access./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>user_control_group/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>CXB User’s Assigned Control Group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (225)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. Uniquely identifies a Client’s Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>first_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s First Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>last_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Customer’s Last Name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The product group Id assigned to the CCID. A CCID can only be assigned to a single product group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>communication_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Possible values are cxb user send, two way user send, autobot send, two way close, and two way ping./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>event_time/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong> timestamp. Contains the date and time when the event occurred. The data is in ISO 8601 format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>control_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Control tag is an attribute of the two way channel, and is used to control CXB Users view of messages./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>twoway_channel_sid/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Unique Identifier of the Two-way Channel./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>div classsect1>h2 id_power_ups_report>a classlink href#_power_ups_report>17. Power-Ups Report/a>/h2>div classsectionbody>h3 idpower-ups-reports classdiscrete>Purpose/h3>div classparagraph>p>Relay’s Power-Ups offering allows for clients to send online forms to their customers on the Relay feed. The Power-Ups Report populates the electronically collected data entered on the forms by customers (i.e. First Name, Last Name, or simple Form Responses to Questions). Clients can access this data through the Relay SFTP offering as both .csv files and individual PDF submissions. This report is available in both Staging and Production Environments./p>/div>h3 id_included_events_5 classdiscrete>Included Events/h3>div classulist>ul>li>p>code>powerups_data.received/code>/p>/li>/ul>/div>h3 id_expected_frequency_5 classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>h3 id_event_properties_20 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The unique, internal Relay feed message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>product_group_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier. The Product Group ID that will be assigned to the Customer. A Customer can only be assigned to a single product group./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The internal, Relay assigned, customer identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique client identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>journey_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID A unique identifier for the journey./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>trigger_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The trigger Id of the Relay experience the event is related to./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. Required. Uniquely identifies a Client’s Customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>client_message_tag/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (4000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>A system passthrough value intended to link triggered experiences to other Client systems./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>experience_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The name given to a collection of messages. An organizational name./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>customer_name/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (300)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Concatenation of first_name, middle_name, last_name if it was included as a hidden field in the Power Up form./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>secondary_account_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (100)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Optional. This field can be used to tie the em>Customer/em> back to another external system/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>submission_id/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (36)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key./strong> Required. UUID The unique identifier of the full Power-Up submission./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>Form ID/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key./strong> Required. UUID A unique Relay identifier for the form (Power-Up) filled out by the customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Time Submitted/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Timestamp of when the customer submitted their answers to a form./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>Submission Value X/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (4000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The Power Up submission answer. Values are defined when the form is created or updated./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>div classsect1>h2 id_inbound_sms_report>a classlink href#_inbound_sms_report>18. Inbound SMS Report/a>/h2>div classsectionbody>h3 idinbound-sms-reports classdiscrete>Purpose/h3>div classparagraph>p>A flat file report of inbound SMS messages over a period of time for a specific short code. This report is available in both Staging and Production Environments./p>/div>h3 id_included_events_6 classdiscrete>Included Events/h3>div classulist>ul>li>p>code>text_message.received/code>/p>/li>/ul>/div>h3 id_expected_frequency_6 classdiscrete>Expected Frequency/h3>div classparagraph>p>The default frequency is daily./p>/div>div classparagraph>p>Clients may request the frequency be changed to weekly or monthly. Monthly reports are generated on the first weekend of each month or the following weekend./p>/div>h3 id_event_properties_21 classdiscrete>Event Properties/h3>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 19.2307%;>col stylewidth: 19.2307%;>col stylewidth: 61.5386%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Field Name/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>event_type/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The event type. Values include code>notification_channel/code>, code>channel_consent/code>, code>mobile_analysis_onboarding/code> and code>account/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>event_subtype/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong>. The sub event type. Values include code>add/code>, code>remove/code>, code>update/code>, code>rejected/code>, and code>deactivate/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>event_timestamp/strong>/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>date/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Primary Key/strong> timestamp. Contains the date and time when the event occurred. The data is in ISO 8601 format./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (10)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Type of the channel, e.g. “SMS”./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (255)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>UUID The unique, internal Relay feed message identifier./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>a2w_mo_ref_id/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (20)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Internal system ID used by the Kaleyra platform for notifications./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>carrier/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (20)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The carrier associated with the mobile number (i.e., Verizon, T-mobile, and AT&T, etc.)/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>short_code/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (10)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Short code that Relay uses to send an SMS message to the customer./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>country_code/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (3)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The country code assoicated with the Customer phone number./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>phone_number/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (10)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>strong>Required/strong>. The phone number associated with the Customer. This field must contain only numeric values./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>message_text/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>string (5000)/p>/div>/div>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The SMS text sent by the customer to the Relay short code./p>/div>/div>/td>/tr>/tbody>/table>/div>/div>h1 id_sftp_management_policy classsect0>a classlink href#_sftp_management_policy>SFTP Management Policy/a>/h1>div classsect1>h2 id_sftp_user_policy>a classlink href#_sftp_user_policy>19. SFTP User Policy/a>/h2>div classsectionbody>div classsect2>h3 id_file_drop_off_and_pick_up_process_summary>a classlink href#_file_drop_off_and_pick_up_process_summary>19.1. File Drop-Off and Pick-Up Process Summary/a>/h3>div classimageblock left>div classcontent>img srcimages/sftp-dropoff-pickup-sample.png altsftp dropoff pickup sample width300>/div>/div>div classparagraph>p>Drop-off and Pick-up folders are created automatically when a new client is created in CX Builder/p>/div>div classsect3>h4 id_drop_off_folder>a classlink href#_drop_off_folder>Drop-Off Folder/a>/h4>div classulist>ul>li>p>This is where the client drops off files that they want pushed through CX Builder. (Example: Onboarding Files, Messaging Files, etc.)/p>div classolist arabic>ol classarabic>li>p>post all cca files into code>em>/dropoff/cca/em>/code>/p>/li>li>p>post all deactivation files into code>em>/dropoff/deactivation/em>/code>/p>/li>li>p>post all messaging files into code>em>/dropoff/messaging/em>/code>/p>/li>li>p>post all mobile analysis files into code>em>/dropoff/mobile_analysis/em>/code>/p>/li>li>p>post all onboarding files into code>em>/dropoff/onboarding/em>/code>/p>/li>li>p>post all phone number management files into code>em>/dropoff/phone_management/em>/code>/p>/li>/ol>/div>/li>li>p>When clients are dropping files to Relay, they have encrypted it with strong>Relay’s public PGP key/strong>. We maintain the private PGP key that enables only Relay to decrypt the files./p>/li>/ul>/div>/div>div classsect3>h4 id_pick_up_folders>a classlink href#_pick_up_folders>Pick-Up Folders/a>/h4>div classulist>ul>li>p>This is where return data and files that the client is picking up from Relay are placed. (Example: Connection Feed, Message Funnel, and Reject Files)/p>div classolist arabic>ol classarabic>li>p>pickup all cca REJECT files from code>em>/pickup/cca/em>/code>/p>/li>li>p>pickup all deactivation REJECT files from code>em>/pickup/deactivation/em>/code>/p>/li>li>p>pickup all messaging REJECT files from code>em>/pickup/messaging/em>/code>/p>/li>li>p>pickup all mobile analysis REJECT files from code>em>/pickup/mobile_analysis/em>/code>/p>/li>li>p>pickup all onboarding REJECT files from code>em>/pickup/onboarding/em>/code>/p>/li>li>p>pickup all connection feed report from code>em>/pickup/report/em>/code>/p>/li>li>p>pickup all message funnel report from code>em>/pickup/report/em>/code>/p>/li>/ol>/div>/li>li>p>The File Engine in CX Builder uses the strong>client-provided public PGP/GPG/strong> key to encrypt all files going into the pickup folders./p>/li>li>p>Client will use strong>their private PGP key/strong> to decrypt the files placed in the pick-up location of the SFTP./p>/li>/ul>/div>/div>/div>div classsect2>h3 id_power_ups_form_reporting>a classlink href#_power_ups_form_reporting>19.2. Power-Ups Form Reporting/a>/h3>div classulist>ul>li>p>Relay’s Power-Ups offering allows for clients to send online forms to their customers on the Relay feed. From their Relay feed, customers can electronically complete client specific data and questions, submit the form, and/or sign via an Electronic Signature. The data populated on the forms by customers (i.e. First Name, Last Name, or simple Form Responses to Questions) is then stored within the Relay platform.Clients can access this data through the Relay SFTP offering as both .csv files and individual PDF submissions./p>/li>li>p>Files are available in the below folder:/p>div classulist>ul>li>p>code>em>/pickup/report/em>/code>/p>/li>/ul>/div>/li>li>p>Metadata submitted by customers on the form are found in the .csv files with the naming convention: FormID_YYYY_MM_DD_UUID.csv./p>/li>li>p>Individual Forms submitted are compressed in the .zip files with the naming convention: FormID_YYYY_MM_DD_UUID-pdfs.zip/p>/li>/ul>/div>/div>/div>/div>div classsect1>h2 id_sftp_configuration_and_usage>a classlink href#_sftp_configuration_and_usage>20. SFTP Configuration and Usage/a>/h2>div classsectionbody>div classsect2>h3 id_overview_4>a classlink href#_overview_4>20.1. Overview/a>/h3>div classparagraph>p>Relay hosts an SFTP service that provides business users the ability to securely both send and receive flat files (.csv) supporting your customer onboarding, deactivation, and overall customer engagement leveraging the Relay platform. SFTP, or SSH File Transfer Protocol, is a network protocol that provides file access, file transfer, and file management over a reliable data stream. Based on your use cases, review the implementation flow, best practices, and configuration setup guide./p>/div>/div>div classsect2>h3 id_client_implementation_flow>a classlink href#_client_implementation_flow>20.2. Client Implementation Flow/a>/h3>div classimageblock>div classcontent>img srcimages/sftp-client-implementation-flow.png altsftp client implementation flow>/div>/div>/div>div classsect2>h3 id_before_you_get_started_relay_best_practices>a classlink href#_before_you_get_started_relay_best_practices>20.3. Before You Get Started - Relay Best Practices/a>/h3>div classsect3>h4 id_security_setup>a classlink href#_security_setup>Security Setup/a>/h4>div classulist>ul>li>p>Install 1 SSH2 key per environment./p>/li>li>p>Do not share SSH2 keys across your organization./p>/li>li>p>Confirm firewall, VPN, or security policies do not block ports or protocols for SFTP and SSH./p>/li>/ul>/div>/div>div classsect3>h4 id_recommended_transmission_frequency>a classlink href#_recommended_transmission_frequency>Recommended Transmission Frequency/a>/h4>div classulist>ul>li>p>Drop files max every 15 minutes./p>/li>li>p>Pickup files max every 60 minutes./p>/li>li>p>Archive files every 60 days otherwise note Relay’s SFTP Folder Management Policy below./p>/li>/ul>/div>div classadmonitionblock note>table>tr>td classicon>i classfa icon-note titleNote>/i>/td>td classcontent>Increased frequency requirements should consider using Relay’s API platform and web hook offering./td>/tr>/table>/div>/div>div classsect3>h4 id_monitoringerror_handling>a classlink href#_monitoringerror_handling>Monitoring/Error Handling/a>/h4>div classulist>ul>li>p>Implement a retry policy if/when a file outbound or file inbound process fails./p>/li>li>p>Implement a notification policy to your internal technology team and forward this team email to Relay for the same purpose./p>/li>/ul>/div>/div>div classsect3>h4 id_know_your_3rd_party_tools>a classlink href#_know_your_3rd_party_tools>Know your 3rd party tools/a>/h4>div classulist>ul>li>p>Clients have used multiple, proprietary 3rd party tools with SFTP, such as Filezilla, Cyberduck, WinSCP, etc./p>/li>li>p>These tools have different settings and configurations that influence SFTP connectivity and authentication unbeknownst to Relay./p>/li>li>p>Relay does not support 3rd party tools. If you need additional troubleshooting guidance, reference the applicable help sites:/p>div classulist>ul>li>p>a hrefhttps://docs.cyberduck.io>Cyberduck/a>/p>/li>li>p>a hrefhttps://winscp.net/eng/docs/start>WinSCP/a>/p>/li>li>p>a hrefhttps://filezilla-project.org/support.php>Filezilla/a>/p>/li>/ul>/div>/li>/ul>/div>/div>/div>div classsect2>h3 id_sftp_folder_management_policy>a classlink href#_sftp_folder_management_policy>20.4. SFTP Folder Management Policy/a>/h3>div classparagraph>p>It is the policy of Relay Network to maintain files within Relay controlled SFTP folders for 60 days. Files less than 60 days old will remain available in their respective folders for research, re-processing, re-delivery, or troubleshooting./p>/div>div classparagraph>p>After 60 days,/p>/div>div classulist>ul>li>p>input files in /dropoff and any of its sub-folders are deleted./p>/li>li>p>reports in /pickup/report are deleted./p>/li>li>p>reject files in /pickup and any of its sub-folders are deleted./p>/li>li>p>Clients should take the necessary steps to internally archive what is required./p>/li>/ul>/div>/div>div classsect2>h3 id_configuration_setup_detail>a classlink href#_configuration_setup_detail>20.5. Configuration Setup Detail/a>/h3>div classolist arabic>ol classarabic>li>p>The Relay IP addresses:/p>div classulist>ul>li>p>Relay hosts 3 static IP addresses per environment, that can be whitelisted if required./p>/li>li>p>IP Addresses:/p>div classulist>ul>li>p>Production Static IPs: (sftpv3.relayzone.com)/p>div classulist>ul>li>p>54.163.151.214/p>/li>li>p>3.212.186.15/p>/li>li>p>35.168.138.224/p>/li>/ul>/div>/li>li>p>Staging Static IPs (sftp-staging.relaystaging.com)/p>div classulist>ul>li>p>44.232.142.161/p>/li>li>p>54.70.22.120/p>/li>li>p>52.36.59.231/p>/li>/ul>/div>/li>/ul>/div>/li>/ul>/div>/li>li>p>Relay’s strong>Public PGP Key/strong>:/p>div classulist>ul>li>p>A PGP key is used for encryption/decryption, while an SSH key is used for authentication./p>/li>li>p>Relay will email Relay’s strong>public PGP key/strong> to the client./p>div classulist>ul>li>p>Relay’s strong>public PGP key/strong> is used to encrypt the client’s customer data files that they send to Relay. (dropoff folders)/p>/li>li>p>Relay will work with the client to test and confirm the PGP key works as expected./p>/li>/ul>/div>/li>/ul>/div>/li>/ol>/div>/div>div classsect2>h3 id_client_will_need_to_provide>a classlink href#_client_will_need_to_provide>20.6. Client will need to provide/a>/h3>div classolist arabic>ol classarabic>li>p>SSH2 Keys/p>div classulist>ul>li>p>SSH2 keys are used for authentication to the SFTP site. Relay uses SSH2 for authentication rather than generic passwords for higher security./p>/li>li>p>It is preferred to have an SSH2 key per environment:/p>div classulist>ul>li>p>Production Environment/p>/li>li>p>Staging Environment/p>/li>/ul>/div>/li>li>p>After Relay receives and configures the keys for both environments, a username will be provided to the client. A combination of username and SSH2 key will be used to authenticate. No password is required./p>div classulist>ul>li>p>We will test the connectivity by requesting a drop-off sample file for each file in use./p>/li>li>p>Both automated and manual file posting connectivity should be tested./p>/li>/ul>/div>/li>/ul>/div>/li>li>p>Client’s Encryption key/p>div classulist>ul>li>p>Relay will request the clients PGP or GPG (strong>we support both/strong>) keys./p>/li>li>p>The file must be .asc format./p>/li>li>p>Once received, Relay will test and confirm the keys and add those to your client within the portal./p>div classulist>ul>li>p>A sample file that will reject a record can be created to ensure the rejection files are automatically encrypted when delivered to the pickup/XXX folders./p>/li>/ul>/div>/li>/ul>/div>/li>/ol>/div>/div>div classsect2>h3 id_frequently_asked_questions>a classlink href#_frequently_asked_questions>20.7. Frequently Asked Questions/a>/h3>div classolist arabic>ol classarabic>li>p>strong>When are the Relay hosted SFTP folder structures created?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>Once your Client Success manager creates the client ID in the Relay CX Portal, the folders are created, but the SSH2 key and PGP key steps must be completed during your implementation./p>/li>/ol>/div>/li>li>p>strong>Can the file be transmitted as SSH and SSH2?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>The file must be sent to Relay as an SSH2 file. When this is then uploaded, the Relay CX Portal confirms whether the format is valid. If it is not, it throws an error./p>/li>/ol>/div>/li>li>p>strong>For the encryption keys used for the SFTP service, do the keys require a passphrase?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>No, there is no passphrase for the SFTP encryption keys./p>/li>/ol>/div>/li>li>p>strong>What is the file format for the GPG key?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>GPG key must have a file extension of .asc./p>/li>/ol>/div>/li>li>p>strong>I am trying to connect to Relay’s SFTP service using Cyberduck, Filezilla, or WinSCP, but I am receiving an invalid connection error. What is the issue?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>Relay uses SSH2 for authentication. This does not require a password. Confirm you are not attempting to pass one./p>/li>li>p>Check that your SSH2 public key has been uploaded to the Relay Customer Experience portal under your client id./p>/li>li>p>Am I using my private SSH2 key or the public? You should use your private SSH2 key to connect to Relay. The public key is stored on Relay’s side./p>/li>/ol>/div>/li>li>p>strong>I am using the correct SSH2 key to try and connect, but I am still getting a connection key error and/or an error on my local client “Possible DNS Spoofing Detected.” Are there other potential issues?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>Some clients also validate against an SSH Server’s host keys./p>div classolist lowerroman>ol classlowerroman typei>li>p>Check to see if StrictHostKeyChecking is enabled/disabled for your SSH client./p>/li>li>p>Clear any host key caches./p>/li>li>p>Update any stored host keys with the current Relay SSH server host key upon trying to make the connection./p>/li>/ol>/div>/li>/ol>/div>/li>li>p>strong>I am trying to view the list of files within the /dropoff/onboarding or another folder, but my 3rd party software is crashing./strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>This is often a user interface issue. If there are thousands of files listed in any one folder, often 3rd party software such as WinSCP fails because it is unable to return such a large list of folder names./p>/li>/ol>/div>/li>li>p>strong>Should I whitelist Relay IP Addresses?/strong>/p>div classolist loweralpha>ol classloweralpha typea>li>p>Relay has provided the static IP feature for some clients that still whitelist IP addresses based on their risk tolerance policy, however, with other forms of security and with SAS providers often rotating their IP addresses it is not always employed./p>/li>li>p>Relay has clients in both scenarios, where some have whitelisted and others have declined./p>/li>/ol>/div>/li>/ol>/div>/div>/div>/div>div classsect1>h2 id_data_models>a classlink href#_data_models>Appendix A: Data Models/a>/h2>div classsectionbody>div stylepage-break-after: always;>/div>div classsect2>h3 idaddress-model>a classlink href#address-model>A.1. Address Object/a>/h3>div classparagraph>p>The code>Address/code> object is always contained inside other objects, it is never used standalone./p>/div>h4 id_address_json_format classdiscrete>Address JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>address/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 161/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address3/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>USA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span> } }/code>/pre>/div>/div>h4 id_address_json_properties classdiscrete>Address JSON Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>address1/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the first line of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>address2/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the second line of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>address3/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the thrid line of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>address4/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the fourth line of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>country/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies country of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>city/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies city of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>state_province/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(2)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies state or province of the address./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>postal_code/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies postal code of the address./p>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idCCA-model>a classlink href#CCA-model>A.2. CCA Object/a>/h3>h4 id_cca_json_format classdiscrete>CCA JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7873-1855-2986-5451/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span> : , span classkey>span classdelimiter>"/span>span classcontent>secondary_account_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Harrison/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Marc/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Rose/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1990-05-06/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn_last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1101/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>US/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 200/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address3/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>c/o Paul Raden/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Relay Network, Inc./span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { }}/code>/pre>/div>/div>h4 id_cca_json_properties classdiscrete>CCA JSON Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required./strong> Uniquely identifies a Client’s code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>product_group/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required./strong> Contains the Product Group ID that the Customer will be associated with/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>secondary_account_id/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This field can be used to tie the em>Customer/em> back to another external system/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>first_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the first name of the code>Customer/code>./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>middle_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the middle name of the code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>last_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the last name of the code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>date_of_birth/p>/td>td classtableblock halign-left valign-top>p classtableblock>a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601 Date/a>/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the date of birth of the code>Customer/code>./p>p classtableblock>Format: yyyy-mm-dd/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ssn_last4/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(4)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the last 4 digits of the code>Customer/code> social security number./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>gender/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(1)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifies the gender of the code>Customer/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>addresses/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the code>Address/code> of the code>Customer/code>./p>p classtableblock>See: a href#address-model>Address Object/a>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ext/p>/td>td classtableblock halign-left valign-top>p classtableblock>object/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>ext/code> object allows Customers to extend the object with additional properties./p>/div>div classparagraph>p>See: a href#ext-model>Ext Object/a>/p>/div>/div>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idconsent-model>a classlink href#consent-model>A.3. Consent Object/a>/h3>h4 id_consent_json_format classdiscrete>Consent JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>relay_developer/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>2017-07-05T22:16:12.934Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>2017-07-05T22:16:12.934Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>written|express|stop/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_consent_json_properties classdiscrete>Consent JSON Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>client_id/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. Identifies the code>Client/code> that the code>Consent/code> object is assocated with./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_at/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a>/p>/div>/div>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the date and time when the code>Consent/code> object was created./p>p classtableblock>e.g. 2017-06-27T13:08:49Z/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the ID of the user who created the code>Consent/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_by_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the name of the user who created the code>Consent/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_at/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a>/p>/div>/div>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the date and time when the code>Consent/code> object was updated/p>p classtableblock>e.g. 2017-06-27T13:08:49Z/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the ID of the user who last updated the code>Consent/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_by_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the name of the user who last updated the code>Consent/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(40)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifies the type of channel./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>sms/td>td classhdlist2>p>The channel refers to an SMS Mobile Number/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>channel_addr/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the channel address. This value differs based on the code>channel_type/code> property./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>consent_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(40)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifies the current consent type for the identified channel.br>/p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>express/td>td classhdlist2>p>The channel has express consent/p>/td>/tr>tr>td classhdlist1>written/td>td classhdlist2>p>The channel has express written consent/p>/td>/tr>tr>td classhdlist1>stop/td>td classhdlist2>p>The channel has stop consent/p>/td>/tr>/table>/div>/div>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idcontact-model>a classlink href#contact-model>A.4. Contact Object/a>/h3>div classparagraph>p>The code>Contact/code> object is referenced by the following objects:/p>/div>div classulist>ul>li>p>a href#client-model>client-model/a>/p>/li>li>p>a href#product-group-model>product-group-model/a>/p>/li>/ul>/div>h4 id_contact_json_format classdiscrete>Contact JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>email/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>mobile_number/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span> : { }}/code>/pre>/div>/div>h4 id_contact_json_properties classdiscrete>Contact JSON Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>first_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifes the first name of the contact/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>last_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifes the last name of the contact/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>email/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(255)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifes the email address associated with the contact/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>mobile_number/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifes the mobile phone number associated with the contact/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ext/p>/td>td classtableblock halign-left valign-top>p classtableblock>object/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>ext/code> object allows Customers to extend the object with additional properties./p>/div>div classparagraph>p>See: a href#ext-model>Ext Object/a>/p>/div>/div>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idcustomer-model>a classlink href#customer-model>A.5. Customer Object/a>/h3>h4 id_customer_json_format classdiscrete>Customer JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>548b648f-86dc-4f15-b556-e00a41f6e3dd/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-01-01T12:00:00Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_by/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>41469fa6-f678-4a4e-a5b0-416b31f6ee42/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_by_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Jim Collins/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-01-01T12:00:00Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_by/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>41469fa6-f678-4a4e-a5b0-416b31f6ee42/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_by_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Jim Collins/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>QaClient-5249-2334-5211-8618/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>7873-1855-2986-5451/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>first_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Harrison/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>middle_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Marc/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Rose/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>date_of_birth/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1990-05-06/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>ssn_last4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1101/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>gender/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>M/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span> : , span classkey>span classdelimiter>"/span>span classcontent>addresses/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>country/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>US/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address1/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>201 King of Prussia Road/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address2/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Suite 200/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address3/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>c/o Paul Raden/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>address4/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Relay Network, Inc./span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>city/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Radnor/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>state_province/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>PA/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>postal_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>19087/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1198751825/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_number/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>198751825/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>mobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>consent_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>written|express|stop/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>phone_number/span>span classdelimiter>"/span>/span>: , span classkey>span classdelimiter>"/span>span classcontent>email/span>span classdelimiter>"/span>/span>: {}, span classkey>span classdelimiter>"/span>span classcontent>ext/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>member_since/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>1999/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>membership_level/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>gold/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>renewal_date/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>05/01/2019/span>span classdelimiter>"/span>/span> }}/code>/pre>/div>/div>table classtableblock frame-topbot grid-rows stretch>caption classtitle>Table 19. Customer JSON Properties/caption>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>strong>id/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required/strong>. The unqiue Relay identifier for the code>Customer/code> object./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>strong>ccid/strong>/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>strong>Required./strong> Uniquely identifies a Client’s code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_at/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a>/p>/div>/div>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the date and time when the code>Customer/code> object was created./p>p classtableblock>e.g. 2017-06-27T13:08:49Z/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the ID of the user who created the code>Customer/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>created_by_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the name of the user who created the code>Customer/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_at/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>a hrefhttps://en.wikipedia.org/wiki/ISO_8601>ISO 8601/a>/p>/div>/div>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the date and time when the code>Customer/code> object was updated/p>p classtableblock>e.g. 2017-06-27T13:08:49Z/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_by/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the ID of the user who last updated the code>Customer/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>updated_by_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>This optional property contains the name of the user who last updated the code>Customer/code> object.If this record was updated with an API token, instead of a user session, then this property will not be present./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>first_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the first name of the code>Customer/code>./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>middle_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the middle name of the code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>last_name/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(100)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the last name of the code>Customer/code>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>date_of_birth/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the date of birth of the code>Customer/code>./p>p classtableblock>Format: yyyy-mm-dd/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>address/p>/td>td classtableblock halign-left valign-top>p classtableblock>Address/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifies the code>Address/code> of the code>Customer/code>./p>p classtableblock>See: a href#address-model>Address Object/a>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ssn_last4/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(4)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the last 4 digits of the code>Customer/code> social security number./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>gender/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(1)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifies the gender of the code>Customer/code>./p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>notification_channels/p>/td>td classtableblock halign-left valign-top>p classtableblock>array/p>/td>td classtableblock halign-left valign-top>p classtableblock>Optional array of code>Phone/code> objects.br>/p>p classtableblock>See: a href#phone-model>Phone Object/a>/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>ext/p>/td>td classtableblock halign-left valign-top>p classtableblock>object/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>The code>ext/code> object allows Customers to extend the object with additional properties./p>/div>div classparagraph>p>See: a href#ext-model>Ext Object/a>/p>/div>/div>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idext-model>a classlink href#ext-model>A.6. Ext Object/a>/h3>div classparagraph>p>The code>ext/code> object is used to extend other objects - it is never used by itself. Clients extend other objects by adding additional property name value pairs to the code>code>ext/code>/code> object./p>/div>h4 id_ext_object_limitations classdiscrete>Ext Object Limitations/h4>div classulist>ul>li>p>It can contain a maximum of 20 additional properties/p>/li>li>p>The property name must not exceede 30 characters/p>/li>li>p>The property value must be of type code>String/code>/p>/li>li>p>The property value must not exceede a length of 1024 characters/p>/li>/ul>/div>h4 id_ext_json_format classdiscrete>Ext JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>name1/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>name2/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, . .}/code>/pre>/div>/div>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idmessage-details-model>a classlink href#message-details-model>A.7. Message Details Object/a>/h3>h4 id_message_details_json_format classdiscrete>Message Details JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>data/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:57.498Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>last_event_captured/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>wire.message.undelivered/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_data/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>product_groups/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> } }, span classkey>span classdelimiter>"/span>span classcontent>message_detail/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>campaign/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>custom_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>is_alternate_message/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:57.491Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>message_events/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>actions/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>description/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>Help/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>taken_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2019-10-23T14:25:10.312Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>hyperlink/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>value/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>https://google.com/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>delivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:57.514Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_reason/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_events/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>auth_link_clicked_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>delivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:58.007Z/span>span classdelimiter>"/span>/span> }, { span classkey>span classdelimiter>"/span>span classcontent>client_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:59.451Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_data/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>ccid/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>customer_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_channels/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>product_groups/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> } }, span classkey>span classdelimiter>"/span>span classcontent>last_event_captured/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms.delivery-receipt.received/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>message_detail/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>campaign/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>custom_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>is_alternate_message/span>span classdelimiter>"/span>/span>: span classpredefined-constant>false/span>, span classkey>span classdelimiter>"/span>span classcontent>job_created_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:59.433Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>job_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>journey_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>message_events/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>actions/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>delivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:59.476Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_reason/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> }, span classkey>span classdelimiter>"/span>span classcontent>message_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>notification_events/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>auth_link_clicked_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_addr/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>16105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>channel_type/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>sms/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>delivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:20:59.476Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>undelivered_reason/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>product_group_id/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>default/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>product_group_name/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>updated_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:19:59.960Z/span>span classdelimiter>"/span>/span> } , span classkey>span classdelimiter>"/span>span classcontent>max_updated_at/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>2017-12-27T19:20:59.960Z/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>parameters/span>span classdelimiter>"/span>/span>: { span classkey>span classdelimiter>"/span>span classcontent>limit/span>span classdelimiter>"/span>/span>: span classinteger>2/span> }, span classkey>span classdelimiter>"/span>span classcontent>row_count/span>span classdelimiter>"/span>/span>: span classinteger>2/span>, span classkey>span classdelimiter>"/span>span classcontent>truncated/span>span classdelimiter>"/span>/span>: span classpredefined-constant>false/span>}/code>/pre>/div>/div>h4 id_message_details_properties classdiscrete>Message Details Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>parameters/p>/td>td classtableblock halign-left valign-top>p classtableblock>object/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the list of parameters and their values that were used for this request./p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>row_count/p>/td>td classtableblock halign-left valign-top>p classtableblock>integer/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Specifies the number of returned code>Message Details/code> objects/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>data/p>/td>td classtableblock halign-left valign-top>p classtableblock>collection/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Contains the returned collection of code>Message Details/code> objects/p>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>truncated/p>/td>td classtableblock halign-left valign-top>p classtableblock>boolean/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifies if the list has been truncated./p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>true/td>td classhdlist2>p>The returned list has been trucated based on the code>limit/code> query paramter.Another call will be required to return additional objects./p>/td>/tr>tr>td classhdlist1>false/td>td classhdlist2>p>The returned list was not truncated. There is no more data based on the query parameters./p>/td>/tr>/table>/div>/div>/td>/tr>/tbody>/table>div stylepage-break-after: always;>/div>/div>div classsect2>h3 idphone-model>a classlink href#phone-model>A.8. Phone Object/a>/h3>div classparagraph>p>The code>Phone/code> object is referenced by the following objects:/p>/div>div classulist>ul>li>p>a href#customer-model>Customer Object/a>/p>/li>/ul>/div>h4 id_phone_json_format classdiscrete>Phone JSON Format/h4>div classlistingblock>div classcontent>pre classCodeRay highlight>code data-langjavascript>{ span classkey>span classdelimiter>"/span>span classcontent>phone_number/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>6105551212/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>phone_type/span>span classdelimiter>"/span>/span> : span classstring>span classdelimiter>"/span>span classcontent>mobile/span>span classdelimiter>"/span>/span>, span classkey>span classdelimiter>"/span>span classcontent>country_code/span>span classdelimiter>"/span>/span>: span classstring>span classdelimiter>"/span>span classcontent>1/span>span classdelimiter>"/span>/span>}/code>/pre>/div>/div>h4 id_phone_json_properties classdiscrete>Phone JSON Properties/h4>table classtableblock frame-topbot grid-rows stretch>colgroup>col stylewidth: 16.6666%;>col stylewidth: 12.5%;>col stylewidth: 70.8334%;>/colgroup>thead>tr>th classtableblock halign-left valign-top>Property/th>th classtableblock halign-left valign-top>Type/th>th classtableblock halign-left valign-top>Description/th>/tr>/thead>tbody>tr>td classtableblock halign-left valign-top>p classtableblock>phone_number/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Contains the phone number./p>p classtableblock>Max length 40/p>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>phone_type/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(10)/p>/td>td classtableblock halign-left valign-top>div classcontent>div classparagraph>p>Identifes the type of phone number.br>/p>/div>div classparagraph>p>Valid values are:/p>/div>div classhdlist>table>tr>td classhdlist1>mobile/td>td classhdlist2>p>The phone number is associated with a mobile number/p>/td>/tr>tr>td classhdlist1>landline/td>td classhdlist2>p>The phone number is assicated with a landline/p>/td>/tr>tr>td classhdlist1>unknown/td>td classhdlist2>p>The type of phone number is unknown/p>/td>/tr>/table>/div>/div>/td>/tr>tr>td classtableblock halign-left valign-top>p classtableblock>country_code/p>/td>td classtableblock halign-left valign-top>p classtableblock>string(3)/p>/td>td classtableblock halign-left valign-top>p classtableblock>Identifes the country code of the phone number./p>p classtableblock>Default value 1 (North America)/p>p classtableblock>a hrefhttps://en.wikipedia.org/wiki/List_of_country_calling_codes classbare>https://en.wikipedia.org/wiki/List_of_country_calling_codes/a>/p>/td>/tr>/tbody>/table>/div>/div>/div>div classsect1>h2 id_data_transfer_relay_to_client>a classlink href#_data_transfer_relay_to_client>Appendix B: Data Transfer - Relay to Client/a>/h2>div classsectionbody>div classparagraph>p>This section documents the IP addresses that Relay uses when pushing data to clients leveraging the Push API Webhook or SFTP processes. Clients can choose to whitelist to the IP addresses for each environment, although it is not required./p>/div>h3 id_relay_staging_environment classdiscrete>Relay Staging Environment/h3>div classulist>ul>li>p>50.112.172.205/p>/li>/ul>/div>h3 id_relay_production_environment classdiscrete>Relay Production Environment/h3>div classulist>ul>li>p>52.73.72.6/p>/li>/ul>/div>/div>/div>/div>div idfooter>div idfooter-text>Version 3.20br>Last updated 2024-07-01 19:11:46 UTC/div>/div>p classfooter-text>Copyright © 2021 by Relay Network, LLC. All Rights Reserved./p>/body>/html>
Subdomains
Date
Domain
IP
looker.relayzone.com
2024-04-30
34.199.67.203
clientdocs.relayzone.com
2024-07-03
3.163.24.124
www.relayzone.com
2024-04-30
52.206.50.135
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]