Circuit JavaScript SDK

API Docs for version 1.3.1811

IncomingWebhook

Module: Circuit

Summary

Data object defining an incoming webhook. Used for incoming webhooks with the circuit web client.

Properties

conversationId

Syntax

conversationId

String

Summary

The conversation id the webhook belongs to.

creationTime

Syntax

creationTime

Number

Summary

The time when the webhook was created.

creatorId

Syntax

creatorId

String

Summary

The user ID of the user who created the webhook.

description

Syntax

description

String

Summary

Detailed description of the webhook usage.

modificationTime

Syntax

modificationTime

Number

Summary

The time when the webhook was modified last.

name

Syntax

name

String

Summary

The name of the webhook.

status

Syntax

status

String

Summary

The webhook status.

tenantId

Syntax

tenantId

String

Summary

The tenant id the webhook belongs to.

userId

Syntax

userId

String

Summary

The id of the user for which the message of the incoming webhook is posted. This can either be the creator which is the case if user create webhooks for themselve or the user ID of a bot, for example when somebody with the DEVELOPER_CONSOLE_MANAGE permission creates an incoming webhook for a bot.

webhookId

Syntax

webhookId

String

Summary

The unique identifier of the webhook.