---
schema_version: "1"
id: 8d7fb783da4d9441b02b670f2296450af08effca610b971c20e0dc9d672ce3c8
title: PulseErrorEvent | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/PulseErrorEvent.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseErrorEvent.html
source_site: help.tableau.com
content_type: documentation
content_hash: 3904ef6dee079cac9b11f1b00282f7ee0bb8cc8e8a415fd231e0681811f9e836
description: Documentation for Tableau Embedding API
---
- PulseErrorEvent

# Interface PulseErrorEvent

Event which is triggered when an internal Pulse error is encountered.

interface PulseErrorEvent {  
    [httpStatus](#httpstatus): number;  
    [message](#message): string;  
    [messageVisibility](#messagevisibility): [PulseErrorMessageVisibility](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseErrorMessageVisibility.html);  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:298

##### Index

### Properties

[httpStatus](#httpstatus) [message](#message) [messageVisibility](#messagevisibility)

## Properties

### `Readonly`httpStatus[](#httpstatus)

httpStatus: number

The HTTP status code of the failing API call that caused the error.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:310

### `Readonly`message[](#message)

message: string

The error message. If the error popup is visible, this is the message it shows. If the error popup is hidden, this is the message it would have shown. If the error popup is suppressed, this message would not have been shown to the user at all.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:305

### `Readonly`messageVisibility[](#messagevisibility)

messageVisibility: [PulseErrorMessageVisibility](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseErrorMessageVisibility.html)

The visibility state of the error message popup. If the error popup was shown to the user, the value is 'visible'. If the error popup was hidden by the page embedding the metric, the value is 'hidden'. If the error popup was hidden by Pulse due to the error not needing to be shown to the user, the value is 'suppressed'.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:318

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[httpStatus](#httpstatus)[message](#message)[messageVisibility](#messagevisibility)