The recipient's mailbox was full and couldn't receive any messages. "createdById": 4488275, Learn more about managing privacy consent banner cookies. Domain authentication failed due to a policy on the recipient's end. If youve previously sent analytics data to HubSpot using the visitors ID only, you can later include both the ID and an email address to associate the data from that ID with a contact. When using a. By clicking on the subscription preferences link in the message, they can change their subscriptions, either subscribing or unsubscribing from various lists, triggering a STATUSCHANGE event. 
the visitor was previously identified by ID and also has a form submission associated with their record. The number of emails still trying to reach a contact's inbox. 513 "isLocalTimezoneSend": false, Learn more aboutthis changeand how tomigrate an API key integrationto use a private app instead. The recipient has beenquarantined due to suspicious form activity. They wont be sent to in the future. Is there anything we could change to make this article helpful? The message was rejected, either by HubSpot or by our delivery provider, and no attempt will be made to deliver the message. The EventId which uniquely identifies the follow-on event which makes this current event obsolete. Starting November 30, 2022, API keys will be sunset as an authentication method. "customReplyTo": "", "id": 5681632705, We make every effort to reject messages before passing them along to our delivery provider. The domain is set automatically based on the URL of the page on load, and the path that is set using this function is always treated as relative to that detected domain. Starting November 30, 2022, API keys will be sunset as an authentication method. "canSpamSettingsId": 1392522301, "abHoursToWait": 1, "ab": false, Use a negative value to sort in descending order (e.g. The email address of the user who submitted the unbounce request. "rssEmailBlogImageMaxWidth": 0, The Email Events API is used to get information about events generated by marketing emails or email campaigns sent through a HubSpot account. See below for the possible values. 
Tracking lawful basis of processing in HubSpot. Restore a previous version of the template, Get all pipelines for a specified object type, Supporting imports with the Ecommerce Bridge, Get all sync errors for a specific account, Get all sync errors for a specific account from a specific app, View subscription status of email address, Update subscription status of email address, Get campaign IDs with recent activity for a portal, Get campaign data for a particular Campaign, Get event data for a campaign or recipient, Submit form data (Supporting Authentication), Determine the buffer of a marketing email, Create or update a group of timeline events, Unenroll (remove) a contact from a workflow. This function does not support any arguments. Can't find what you're looking for? The email address of the recipient of the email message. Ask in the community. Note: you will not be able to send emails through this API. There are 12 event types that can be generated by HubSpot's Email API during the lifecycle of an email message. How do I find the app ID for a HubSpot app? See below for more information on event types. For the latest stable version of the check out this page. The number of contacts that were not sent your email. The number of times contacts were sent your email, but they didnt receive it because either their address is invalid, your email hit their spam filter, or your email was marked as spam by other people. the visitor was previously identified by both ID and email. For legacy custom events, please see the legacy documentation. "freezeDate": 1553518847225, Search the docs for APIs, endpoints or guides. "analyticsPageType": "email", The number of contacts that mark the email as spam over the total number of selected contacts. There are three types of events that you can create in HubSpot: For each event type, HubSpot includes a set of standard properties that can capture certain metadata at the time of completion, including UTM parameters or device and operating system metadata. The sum of contacts that have unsubscribed, marked the email as spam, or have hardbounced. ], In this case, the DROPPED event will have its 'dropReason' set to PREVIOUSLY_BOUNCED, and it's 'causedBy' will reference that previous BOUNCE event. Ask in the community. This would include reapplying anyclicked element eventsthat have been set up. Prerequisites for Integrations Platform API, Get analytics data for HubSpot hosted content, Check for the existence of analytics data for an object type, Get a batch of contacts by user token (deprecated), Get the current contents of the auto-save buffer, Determine if the auto-save buffer differs from the live blog post, Validate the auto-save buffer version of the blog post, Copy the contents of the auto-save buffer into the live blog post, Check the status of a file access update task, Gets the current contents of the auto-save buffer, Determine if the auto-save buffer differs from the live layout, Determine if the auto-save buffer differs from the live page, Copy the contents of the auto-save buffer into the live page, Validate the auto-save buffer version of the page, Determine if the auto-save buffer differs from the live template. The page title tracked will be the current value of document.title. An event is uniquely identified by its EventId, which is comprised of the following properties: These properties can be used to look up a specific event via this endpoint. Please see, The number of records to return in the response. You can further customize these events with the. The recipient previously unsubscribed from this subscription. 
While you can't prevent this function from being automatically called when the tracking code loads, you can, If your site is a single-page application, you should avoid including a, Now that you have your event and event property data, click the. An email message will almost always have exactly one submission event associated with it; for example, there will never be multiple SENT events for a message. 
The recipient's email server couldn't or wouldn't accept the message, and no further attempts will be made to deliver the message. the number of contacts that have unsubscribed over the total number of selected contacts. This function reapplies any analytics event handlers that are set up in the analytics settings for the HubSpot account. Is there anything we could change to make this article helpful? To retrieve custom behavioral events, use the web analytics API. The email address of the person requesting the change on behalf of the recipient. "liveDomain": "developers.hubspot.com", { "emailTemplateMode": "DESIGN_MANAGER", Starting November 30, 2022, API keys will be sunset as an authentication method. "categoryId": 2, How do I find the app ID for a HubSpot app? 
Additionally, CLICK events have the following properties: And OPEN events may have the following property: A recipient can also update their communication preferences via the email message. "blogRssSettings": { "rssEmailCommentText": "Comment ", the Analytics API will depend on the connected HubSpot account's permissions. View the above code for examples. (See the Knowledge Base articles linked above for data descriptions.). The v3 Reporting API is currently under development. Restore a previous version of the template, Get all pipelines for a specified object type, Supporting imports with the Ecommerce Bridge, Get all sync errors for a specific account, Get all sync errors for a specific account from a specific app, View subscription status of email address, Update subscription status of email address, Get campaign IDs with recent activity for a portal, Get campaign data for a particular Campaign, Get event data for a campaign or recipient, Submit form data (Supporting Authentication), Determine the buffer of a marketing email, Create or update a group of timeline events, Unenroll (remove) a contact from a workflow. Defaults to 10, Used to get the next page of results. Note that this is independent of subscription status flagging a message as spam does not simply unsubscribe the recipient from the list in question. "replyTo": "noreply@hubspot.com", A STATUSCHANGE event has the following additional properties: There is a 13th event type, which is unrelated to a specific email message. Cross-domain links are only needed when linking to a distinct domain (e.g., domain-one.com and domain-two.com) that is also being tracked for a single HubSpot account. This function should be used by single-page applications to update the current page whenever a page is loaded. "name": "Weekly notification email for blog \"HubSpot API Changelog\"", If you know the visitors email address, its recommended to use that as the unique identifier. Open rate is the percentage of people who opened your email out of the people who were delivered your email. The recipient's filters identified content in the body of the email as suspicious or spammy. "objects": [ Double opt-in was enabled and the recipient had not yet confirmed their subscription. "created": 1522850740250, Tracked events can show up in contacts' timelines. "resolvedDomain": "developers.hubspot.com", 403 response code - The account does not have access to feature required to access this data. The recipient changed their email subscriptions in some way. Function calls are pushed into the _hsq array. How do I find the app ID for a HubSpot app? The URL of the webpage that linked to the URL clicked. It can be used to get additional details on why a particular event caused the following event. Every email sent via HubSpot generates a number of events detailing its lifecycle and how the recipient interacts with its content. Use this function to track aneventusing JavaScript and HubSpot's tracking code. Learn more about this ongoing project here. User engagement events all share the following properties: A JSON object representing the location where the event occurred. For example, a DROPPED event will occur when there was a previous BOUNCE event for the same recipient. The recipient previously unsubscribed from all subscriptions from the account. "mailingListsExcluded": [], "primaryEmailCampaignId": 71086128, Starting November 30, 2022, API keys will be sunset as an authentication method. Is there anything we could change to make this article helpful? EachMarketingemail has the following data: Tracking lawful basis of processing in HubSpot. UNBOUNCE events occur when a particular email address is either automatically or manually unbounced by HubSpot. See below for the possible values. This function call stores the data in the tracker, but the data is not actually passed to HubSpot with this call. Note: We are currently in the process of updating our APIs to improve consistency and completeness. You can then send the identity to HubSpot by making a separate, :events tied to clickable elements on a website page. the number of succesfull deliveries over the number of selected contacts. "emailNote": "", In addition to filtering for an exact match, some fields support other filter types, designated by including two underscores between the field name and the type. The recipient explicitly requested to not receive any emails via HubSpot. Will automatically populate a set of default HubSpot event properties through the tracking code. 
Occasionally, things don't go smoothly, and one of two things happens: delivery is deferred because of a temporary rejection, or delivery fails and won't be retried. Many endpoints allow you to drill down into the results using the d1 and d2 parameters. An email message may also be flagged as spam by the recipient, resulting in a SPAMREPORT event. The reason why the email message was dropped. 
Restore a previous version of the template, Get all pipelines for a specified object type, Supporting imports with the Ecommerce Bridge, Get all sync errors for a specific account, Get all sync errors for a specific account from a specific app, View subscription status of email address, Update subscription status of email address, Get campaign IDs with recent activity for a portal, Get campaign data for a particular Campaign, Get event data for a campaign or recipient, Submit form data (Supporting Authentication), Determine the buffer of a marketing email, Create or update a group of timeline events, Unenroll (remove) a contact from a workflow, Used to authenticate the request. The path of the current page. Get campaign IDs with recent activity for a portal, Get campaign data for a particular Campaign, Get event data for a campaign or recipient. Additionally, this API features two endpoints that return email send related statistics. The recipients email server has temporarily rejected message, and subsequent attempts will be made to deliver the message. If you try to assign two IDs to one email, only the first ID will be associated with the email address. Get the statistics for all marketing emails. The number of contacts that can no longer recive emails from the portal over the total number of selected contacts. allow contact properties to be updated through the tracking code, tied to the contact associated with that usertoken. "htmlTitle": "", The message was not sent, the recipient has been unengaged with previous marketing emails. You can filter for a field by including it as a query parameter. Your account was suspended for non-compliance or deliverability issues. You can still send to these people in the future. This will correspond to your account. Learn more aboutthis changeand how tomigrate an API key integrationto use a private app instead. The customer imported the subscriptions into their portal. The recipient has beenquarantined due to repeated hard bounce rates.
Moteck Sg-2100 Satellite Dish Motor, Bath And Body Works Pretty As A Peach Set, Custom Monthly Planner, Park District Party Room Rentals Near London, Iberostar Cristina Family Room, Fresh Pumpernickel Bread Near New York, Ny, Lego Hulkbuster Infinity War Instructions, Square Live Edge Coffee Table, Aloisia Beauty Glow Exfoliating Soft Peel, Black Suede Fringe Jacket Mens, Silk Lined Beanie Black Owned, Can You Use Retinol After Dr Dennis Gross Peel,
