+
+ |
+ Failed on Ingest: Events that Segment received, but were dropped due to internal data validation rules |
+
+
+ | Empty batch result |
+ empty_batch_result |
+ No messages found for batch result. After processing messages within batch, no messages returned |
+ Check the event payload and client instrumentation |
+
+
+ | Source disabled |
+ source_disabled |
+ Source is not enabled |
+ Check the source settings |
+
+
+ | Batch is empty |
+ empty_batch |
+ The batch request contained no messages |
+ Check the event payload and client instrumentation.
For more information, see the HTTP API Batch documentation |
+
+
+ | Multi user error |
+ multi_user_error |
+ One or more messages within the batch had an error. Only messages without errors were published |
+ Review individual payloads for each error.
For more information, see the HTTP API Errors documentation |
+
+
+ | No userID or anonymousID |
+ no_user_anon_id |
+ The userID or anonymousID was not provided |
+ Check the event payload and client instrumentation.
For more information, see the Anatomy of a Segment message documentation |
+
+
+ | Event not defined |
+ event_not_defined |
+ Track event did not have event name |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Track documentation |
+
+
+ | Track event not a string |
+ event_not_string |
+ Track event name is not a string |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Track documentation |
+
+
+ | Properties field not an object |
+ properties_not_object |
+ The properties field must be an object type |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Track documentation |
+
+
+ | Traits must be an object |
+ traits_not_object |
+ The traits field must be an object type |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Track documentation |
+
+
+ | Name must be non-empty string |
+ name_not_string |
+ For Page or Screen calls, name field was an empty string or not a string |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Page documentation |
+
+
+ | Category field must be a string |
+ category_not_string |
+ For Page or Screen calls, category field was an empty string or not a string |
+ Check the event payload and client instrumentation.
For more information, see the Spec: Page documentation |
+
+
+ | Identifier missing from payload |
+ id_required |
+ All payloads require a userId and/or an anonymousId |
+ Ensure all payloads have a userId and/or anonymousId.
For more information, see the Anatomy of a Segment message documentation |
+
+
+ | Identifier not a string |
+ id_not_string |
+ The userID or anonymousId was an empty string or not a string |
+ Check the event payload and client instrumentation.
For more information, see the Anatomy of a Segment message documentation |
+
+
+ | Consent categoryPreference object does not exist |
+ consent_
categorypreferences
_should_exist |
+ context.consent.
categoryPreferences object is required |
+ Check the event payload and instrumentation for the Segment Consent Preference Updated Track event.
For more information, see the Segment Consent Preference Updated event documentation |
+
+
+ | Consent Categories field must be an object for "Segment Consent Preference Updated" event |
+ consent_
categorypreferences
_fields_should_be_object |
+ context.consent.
categoryPreferences must be an object |
+ Check the event payload and instrumentation for the Segment Consent Preference Updated Track event.
For more information, see the Segment Consent Preference Updated event documentation |
+
+
+ | Consent category preferences not boolean |
+ consent_
categorypreferences
_fields_should_be_bool |
+ Consent preferences for the categories must be boolean |
+ Check the event payload and instrumentation for the Segment Consent Preference Updated Track event.
For more information, see the Segment Consent Preference Updated event documentation |
+
+
+ | Device advertisingId not a string |
+ device_advertisingid
_should_be_string |
+ advertisingId must be a string |
+ Check the event payload and instrumentation for the Segment Consent Preference Updated Track event. |
+
+
+ | Consent version not a number |
+ consent_version_
should_be_number |
+ Version must be a number |
+ Check the event payload and instrumentation for the Segment Consent Preference Updated Track event. |
+
+
+ | Could not decode payload |
+ bad_request |
+ The payload could have an incorrect content type, body, or something else |
+ Fix the payload and include any missing details.
For more information, see the Source Functions documentation |
+
+
+ | Could not read write key from url |
+ unknown_source |
+ Failed to find source with [write_key] |
+ Verify and use the appropriate function webhook URL.
For more information, see the Source Functions documentation |
+
+
+ | Could not find source from write key |
+ unknown_source |
+ Failed to find source with [write_key] |
+ Verify and use the appropriate function webhook URL.
For more information, see the Source Functions documentation |
+
+
+ | Source missing write key |
+ unknown_source |
+ Failed to find source with [write_key] |
+ Verify and use the appropriate function webhook URL.
For more information, see the Source Functions documentation |
+
+
+ | Could not decode internal settings of the source |
+ invalid_settings |
+ Function internal settings are invalid |
+ Fix the function settings. If you need more information to troubleshoot the function settings, contact support.
For more information, see the Source Functions documentation |
+
+
+ | Could not parse content-type |
+ BAD_REQUEST |
+ The payload has an incorrect content type |
+ Fix the payload and include any missing details.
Make sure you're using 'application/json' or 'application/x-www-form-urlencoded' as your content-type header value.
For more information, see the Source Functions documentation |
+
+
+ | Could not parse request body |
+ BAD_REQUEST |
+ The payload has an incorrect body |
+ Ensure the payload uses accurate JSON.
For more information, see the Source Functions documentation |
+
+
+ | Unsupported content-type |
+ BAD_REQUEST |
+ The payload has an incorrect content type |
+ Fix the payload and include any missing details. Make sure you're using 'application/json' or 'application/x-www-form-urlencoded' as your content-type header value.
For more information, see the Source Functions documentation |
+
+
+ | Source/project is disabled |
+ source_disabled
or
SOURCE_DISABLED |
+ The source/project instance is disabled |
+ Enable the source/project instance.
For more information, see the Source Functions documentation |
+
+
+ | Workspace is locked out |
+ locked_workspace |
+ The workspace is disabled |
+ Contact support for more details |
+
+
+ | Function not deployed |
+ internal |
+ The function is not deployed properly |
+ Re-deploy the function. Contact support if the issue persists.
For more information, see the Source Functions documentation |
+
+
+ | Unexpected deploy type |
+ internal |
+ The function must be deployed as an AWS lambda type |
+ Re-deploy the function. Contact support if the issue persists.
For more information, see the Source Functions documentation |
+
+
+ | Invalid deploy ID |
+ internal |
+ The function is missing the lambda ARN |
+ Re-deploy the function. Contact support if the issue persists.
For more information, see the Source Functions documentation |
+
+
+ | Could not call tracking API |
+ TRACKING_API_FAILED |
+ Failed to call tracking API |
+ Check the payload. Contact support if issue persists.
For more information, see the HTTP API documentation |
+
+
+ | Could not call set API |
+ SET_API_FAILED |
+ Failed to call set API because the client was closed |
+ Check the payload. Contact support for more details.
For more information, see the Source Functions documentation |
+
+
+ | Could not call set API |
+ SET_API_FAILED |
+ Failed to call set API |
+ Check the payload. Contact support for more details.
For more information, see the Source Functions documentation |
+
+
+ | Failed to encode into lambda input format |
+ lambda_err
or
internal |
+ Internal encoding error |
+ Contact support for more details |
+
+
+ | Failed to create lambda client |
+ lambda_err |
+ Unexpected lambda error |
+ Contact support for more details |
+
+
+ | Lambda API permanent error |
+ lambda_err |
+ Unexpected lambda error |
+ Contact support for more details |
+
+
+ | Lambda API temporary error |
+ lambda_err |
+ Unexpected lambda error |
+ Contact support for more details |
+
+
+ | Too many lambda API requests |
+ too_many_requests |
+ The incoming event traffic rate exceeds the expected rate. |
+ Contact support for more details.
For more information, see the Rate Limits documentation |
+
+
+ | Function timeout |
+ FUNCTION_TIMEOUT |
+ The function timed out |
+ Optimize the function code.
For more information, see the Functions Usage documentation |
+
+
+ | Function retry error |
+ RETRY_ERROR |
+ Retry error from function code. Retry attempt will be done |
+ Function will be retried. Segment's systems have a retry mechanism where an event will be retried 6 times over a four-hour period with exponential backoff.
For more information, see the Source Functions documentation |
+
+
+ | Function execution error |
+ INVOKE_ERROR |
+ The function failed to execute |
+ Check the function code for syntax and config issues. Contact support if issue persists. |
+
+
+ | Failed to decode function output |
+ internal |
+ Internal error |
+ Reach out to support for more details |
+
+
+ | Failed is not deployed |
+ BAD_DEPLOY |
+ The function is not deployed properly |
+ Re-deploy the function and then reach out to support if issue persists.
For more information, see the Source Functions documentation. |
+
+
+ | Unexpected DeployType. Supported is aws::lambda |
+ BAD_DEPLOY |
+ The function is not deployed properly |
+ Reach out to support if issue persists.
For more information, see the Source Functions documentation. |
+
+
+ | Invalid deploy ID, missing lambda ARN |
+ BAD_DEPLOY |
+ The function is not deployed properly |
+ Re-deploy the function and then reach out to support if issue persists.
For more information, see the Source Functions documentation. |
+
+
+ |
+ Filtered at Source: Events that were discarded due to schema settings or Protocols Tracking Plans |
+
+
+ | Common schema violation |
+ common_schema_violation |
+ Event violated common JSON schema of Tracking Plan |
+ Check event payload against the connected Tracking Plan Common JSON Schema. If the event passes the correct information, then update the tracking plan common JSON schema with the new information.
or:
Update the source configurations settings to allow events that violate the connected Tracking Plan JSON schema:
Source > Settings > Schema Configurations > Advanced Blocking Controls
For more information, see the Common JSON schema documentation |
+
+
+ | Event discard setting |
+ event_setting |
+ The Source is configured to discard events of this type |
+ Check source schema filters.
For more information, see the Source Schema Integrations Filters documentation |
+
+
+ | Schema violation |
+ schema_violation |
+ Source schema is configured to block events that violate the connected Tracking Plan JSON schema. |
+ Check event payload against the connected Tracking Plan Common JSON Schema. If the event passes the correct information, then update the tracking plan common JSON schema with the new information.
or:
Update the source configurations settings to allow events that violate the connected Tracking Plan JSON schema:
Source > Settings > Schema Configurations > Advanced Blocking Controls
For more information, see the Customize your schema controls documentation |
+
+
+ | Unplanned event |
+ unplanned |
+ Source schema configured to block events not defined in the connected Tracking Plan |
+ Check source Configurations:
Settings > Schema Configurations > to allow unplanned events.
OR:
Add the new event in the connected tracking plan so it's recognized as a planned event. For more information, see the Customize your schema controls documentation |
+
+
+ | Unplanned and schema violation |
+ unplanned_and_
schema_violation |
+ Source schema configured to block events not defined in the connected tracking plan. The event also violated the connected tracking plan JSON schema |
+ Update the source schema configurations to allow unplanned events
OR:
Add the new event in the connected tracking plan so it's recognized as a planned event. |
+
+
+ |
+ Filtered at Destination: Events that were discarded due to Destination Filters, filtering in the Integrations object, or per source schema integration filters |
+
+
+ | Filtered by rules |
+ FILTERED_BY_RULES |
+ Event matched a Destination Filter rule |
+ To include events like this, change the Destination Filter to be more specific or exclude this event.
For more information, see the Destination Filters documentation |
+
+
+ | Filtered by integrations object |
+ FILTERED_BY_
INTEGRATIONS_OBJECT |
+ The event was filtered because sending to the destination in the integrations object is disabled |
+ To include events like this, remove filtering from the integrations object.
For more information, see the Filtering with the integrations object documentation |
+
+
+ | Unkown integration |
+ UNKNOWN_INTEGRATION |
+ Destination not registered in the integrations info |
+ Check the event payloads integrations object to ensure all listed destinations are valid. Refer to the destination's documentation for acceptable names.
For more information, see the Filtering with the integrations object documentation |
+
+
+ | Message sent client side |
+ MESSAGE_SENT_CLIENT_SIDE |
+ The message was already sent client side |
+ These events are being sent client side in Device Mode and will not be sent from Segment's servers. Events in this category are sent directly from your website or app to the downstream destination.
For more information, see the Destination methods comparison documentation |
+
+
+ | Unsupported event type |
+ UNSUPPORTED_EVENT_TYPE |
+ The destination does not support this event type |
+ For more information about the events your destination can consume, see the Filtering with the integrations object documentation |
+
+
+ | Invalid settings |
+ INVALID_SETTINGS |
+ The event type is missing one or more required settings |
+ Check your integration type.
For more information, see the Destination settings documentation |
+
+
+ | Functions lock out |
+ FUNCTIONS_LOCK_OUT |
+ The function wasn't executed because the workspace reached its paid limit for functions |
+ To increase your functions limits, upgrade your workspace plan.
For more information, see the Functions usage limits documentation |
+
+
+ | Internal error |
+ INTERNAL |
+ Something went wrong |
+ Contact support for more information |
+
+
+ | Action missing mapping or trigger |
+ NO_MATCHING_MAPPING |
+ The Actions destination is missing either a mapping or trigger for this event |
+ Your event does not meet any trigger cases for your Actions mappings. Please add a mapping with a trigger that accepts this event.
For more information, see the Actions destination FAQ |
+
+
+ | Filtered at mapping |
+ FILTERED_AT_MAPPING |
+ The event was filtered because it did not match the Actions destination mapping |
+ Contact support for more information |
+
+
+ | Failed data encryption |
+ FAILED_DATA_ENCRYPTION |
+ Message delivery failed due to data encryption; either there was an issue encrypting data or failed to deliver data with encrypted values |
+ Check if the destination can accept encrypted data in the fields being encrypted |
+
+
+ | Invalid request |
+ bad_request |
+ The request is either malformed or the function threw an unknown exception |
+ Review the payload to ensure that it aligns with Segment's expectations.
For more information, see the HTTP API Errors documentation |
+
+
+ | Invalid settings |
+ invalid_settings |
+ The function's internal settings are invalid |
+ Fix the function's settings or reach out to support for more details. |
+
+
+ | Invalid event |
+ message_rejected |
+ The function threw exceptions such as InvalidEventPayload or ValidationError |
+ Fix the payload to contain the data needed by the function |
+
+
+ | Unsupported content-type |
+ unsupported_event_type |
+ EventNotSupported or Missing event handler |
+ Add the missing handler to the function code |
+
+
+ | Failed to process request |
+ internal |
+ Segment failed to process the request |
+ Contact support for more information |
+
+
+ | Too many incoming lambda API requests |
+ too_many_requests |
+ The incoming event traffic rate exceeds the expected rate |
+ Contact support for more information |
+
+
+ | Function timeout |
+ gateway_timeout |
+ The function timed out |
+ Check the function code or contact support to increase the timeout |
+
+
+ | Function retry error |
+ retry |
+ Retry errror from function code |
+ Function will be retried automatically |
+
+
+ | Filtered by end user consent |
+ FILTERED_BY_
END_USER_CONSENT |
+ The message was dropped due to the user's consent preferences |
+ Contact support for more information |
+
+
+ |
+ Failed Delivery: Events that have been discarded due to errors or unmet destination requirements |
+
+
+ | Invalid settings |
+ INVALID_SETTINGS |
+ The event is missing some required settings as configured for that integration per event type |
+ Review your Segment settings and make any necessary updates.
For more information, see the Integration Error Codes documentation |
+
+
+ | 429 |
+ 429 |
+ Too many requests were sent in a time frame |
+ These events will be retried automatically.
If the events eventually fail due to too much volume, contact the partner to raise your rate limit.
If the destination allows batching in Segment, you may be able to reduce the total number of requests.
For more information, see the Integration Error Codes documentation |
+
+
+ | Erefused |
+ EREFUSED |
+ There was a temporary problem connecting to the destination's API |
+ This event will be retried automatically.
If the event eventually fails, your Segment configuration settings may contain some invalid settings, or the integration may not be operational.
If your configurations are valid, consider disabling this integration or conact the intagration partner.
For more information, see the Integration Error Codes documentation |
+
+
+ | Unsupported event type |
+ UNSUPPORTED_EVENT_TYPE |
+ The destination does not support this event type |
+ Contact support for more information |
+
+
+ | Message rejected |
+ MESSAGE_REJECTED |
+ Request was blocked |
+ Check the event payload for required fields and data types for all fields and compare it to your destination configuration.
For more information, see the Integration Error Codes documentation |
+
+
+ | 400/Bad request |
+ 400
or
BAD_REQUEST |
+ The downstream API rejected the payload |
+ Review the Response from Destination tab for more information.
For more context, see the Integration Error Codes documentation |
+
+
+ | Etimedout |
+ ETIMEDOUT
or
etimedout |
+ The downstream destination did not send an API response back to Segment in a reasonable amount of time |
+ No action is needed. The delivery will be retried automatically |
+
+
+ | Enotfound |
+ ENOTFOUND |
+ The endpoint URL cannot be found or does not exist |
+ Check the Request from Segment tab to see which URL the request is being sent to and verify that the URL there is correct |
+
+
+ | Internal |
+ INTERNAL |
+ There was a problem connecting to the destination's server |
+ No action needed. Events will be retried when there's a successful connection |
+
+
+ | 404 |
+ 404 |
+ The server cannot find the requested resource |
+ The server cannot find the requested resource. This can happen for a number of reasons, such as:
The requested resource does not exist.
The requested resource has been moved or deleted.
There is a typo in the URL.
The server is experiencing technical difficulties. |
+
+
+ | 307 |
+ 307 |
+ The requested resource was temporarily redirected |
+ Segment will automatically retry the request using the redirected URL |
+
+
+ | 502 |
+ 502 |
+ The server recieved an invalid response from the upstream server |
+ No action needed. Segment will try to send the payload again.
For more information, see the Integration Error Codes documentation |
+
+
+ | 503 |
+ 503 |
+ Server could not handle the request |
+ No action needed. Segment will try to send the payload again.
For more information, see the Integration Error Codes documentation |
+
+
+ | Retry |
+ RETRY |
+ The intitial request was unsuccessful. The request was sent again |
+ No action needed. Segment will continue to retry sending the payload.
For more information, see the Integration Error Codes documentation |
+
+
+ | 401 |
+ 401 |
+ The request could not be completed because the authentication credentials are either invalid or expired |
+ Re-authenticate your account with the partner and update your authentication settings in Segment.
For more information, see the Integration Error Codes documentation |
+
+
+ | Econnreset |
+ ECONNRESET |
+ Segment could not establish a connection to the partner server |
+ Your Segment configurations might contain some invalid settings or the integration may no longer be operational. If your configurations are valid, disable this integration or contact the integration partner.
For more information, see the Integration Error Codes documentation |
+
+
+
{% else %}
{% endif %}
- 
+
+To create a source volume alert:
+1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
+2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
+4. Select one or more of the following alert channels:
+ - **Email**: Select this to receive notifications at the provided email address.
+ - **Slack**: Select this to send alerts to one or more channels in your workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+## Successful delivery rate alerts
+
+You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a percentage you set. For example, if you set a percentage of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
+
+To receive a successful delivery rate alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
+
+To create a successful delivery rate alert:
+1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
+4. Select one of the following alert channels:
+ - **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field.
+ - **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+Segment generates delivery alerts for failed deliveries and successful deliveries, which are the last two stages of the delivery pipeline. As a result, alerts are based on Segment's attempts to send qualified events to your destination, excluding those filtered out by business rules (like protocols, destination filters, or mappings).
\ No newline at end of file
diff --git a/src/connections/auto-instrumentation/configuration.md b/src/connections/auto-instrumentation/configuration.md
new file mode 100644
index 0000000000..1f5af89c19
--- /dev/null
+++ b/src/connections/auto-instrumentation/configuration.md
@@ -0,0 +1,286 @@
+---
+title: Generate Events from Signals
+hidden: true
+---
+
+This guide details how to use signals, and their associated data, generated in one of the Signals SDKs with the Auto-Instrumentation dashboard in your Segment workspace. On this page, you'll find details on:
+
+- Creating custom rules to capture and translate signals into actionable analytics events
+- Example rules that you can use as a basis for further customization
+
+This guide assumes that you've already added the Signals SDK to your application. If you haven't yet, see the [Auto-Instrumentation Setup](/docs/connections/auto-instrumentation/) guide for initial setup.
+
+> info "Auto-Instrumentation Private Beta"
+> Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience.
+
+> success "Enable Auto-Instrumentation"
+> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
+
+
+## Converting signals to events
+
+After you set up the Signals SDK to capture the signals you want to target, you can create rules in your Segment workspace to translate the captured signals into traditional Segment analytics events. These rules are deployed in your application the next time a user launches your app.
+
+### Getting started with rule creation
+
+1. In your Segment workspace, go to to **Connections > Auto-Instrumentation** and click on a source.
+2. Click **Create Rules**.
+
+> info "Where's the Event Builder tab?"
+> The Event Builder tab only appears after you've installed the Auto-Instrumentation snippet in your site or app. If you don’t see the tab, double check your implementation or reach out to your Segment CSM.
+
+### Using the Rules Editor
+
+The Rules Editor is where you define rules that transform raw signal data into analytics events. In the editor, you write functions that convert signals into events and then call them in the `processSignal()` function.
+
+The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
+
+The following example tracks all Screen events:
+
+```javascript
+function screenCall(currentSignal) {
+ if (currentSignal.type == SignalType.Navigation && currentSignal.data.action == NavigationAction.Entering) {
+ analytics.screen(currentSignal.data.screen, null, null)
+ }
+}
+
+function processSignal(signal) {
+ screenCall(signal)
+}
+```
+
+## Signal definitions
+
+Signals come in various types, each associated with specific data that you can use to create analytics events. This section contains code samples that detail each signal type. Because Segment has standardized these definitions across both the Signals-Swift and Signals-Kotlin libraries, they're useful when you create rules in your Segment workspace.
+
+### Base signal
+
+The Base Signal serves as the foundation for all other signal types. It's defined by the `RawSignal