Skip to main content

@slack/web-api / EntityMetadata

Interface: EntityMetadata

Defined in: packages/types/dist/message-metadata.d.ts:26

Description​

Metadata that represents a work object entity.

Properties​

app_unfurl_url?​

optional app_unfurl_url?: string;

Defined in: packages/types/dist/message-metadata.d.ts:56

Description​

The exact URL posted in the source message. Required in metadata passed to chat.unfurl.

entity_payload​

entity_payload: object;

Defined in: packages/types/dist/message-metadata.d.ts:34

actions?​

optional actions?: object;
actions.overflow_actions?​
optional overflow_actions?: EntityActionButton[];
actions.primary_actions?​
optional primary_actions?: EntityActionButton[];

attributes​

attributes: EntityAttributes;

custom_fields?​

optional custom_fields?: EntityCustomField[];

display_order?​

optional display_order?: string[];

fields?​

optional fields?: 
  | ContentItemEntityFields
  | FileEntityFields
  | IncidentEntityFields
  | TaskEntityFields;

slack_file?​

optional slack_file?: FileEntitySlackFile;

Description​

Schema for the given entity type.

entity_type​

entity_type: string;

Defined in: packages/types/dist/message-metadata.d.ts:30

Description​

Entity type.

external_ref​

external_ref: ExternalRef;

Defined in: packages/types/dist/message-metadata.d.ts:48

Description​

Reference (and optional type) used to identify an entity within the developer's system.

url​

url: string;

Defined in: packages/types/dist/message-metadata.d.ts:52

Description​

URL used to identify an entity within the developer's system.