Skip to main content
POST
Unsubscribe from an event

Authorizations

Authorization
string
header
required

An OAuth 2.0 access token, sent as Authorization: Bearer <token>. MessageDesk is the OAuth 2.0 provider (backed by AWS Cognito): an integration such as Zapier obtains the token through the authorization-code flow when a user connects their MessageDesk account. Access tokens are valid for 24 hours and are refreshed with the refresh token.

Body

application/json

Subscription to delete

Subscription to delete

id
string
required

The ID of the webhook subscription to unsubscribe from

Maximum string length: 45
workspaceId
string
required

Workspace ID the subscription belongs to

Maximum string length: 45

Response

OK

createdAt
string
eventName
enum<string>

The name of the event that the webhook is subscribed to

Available options:
AddRemoveOptOutRequest,
AdminDatabaseSeed,
AuthUserUpdated,
BrandCreated,
BandwidthOrderWebhookReceived,
BrandDeleted,
BrandUpdated,
BroadcastCreated,
BroadcastDeleted,
BroadcastMessageSendRequest,
BroadcastMessageSent,
BroadcastUpdated,
CallForwarded,
CallReceived,
CampaignCreated,
CampaignDeleted,
CampaignUpdated,
ClientDeployed,
CommentCreated,
CommentDeleted,
CommentUpdated,
ConsentCreated,
ConsentDeleted,
ConsentUpdated,
ContactCreated,
ContactDeleted,
ContactUpdated,
ContactPropertyCreated,
ContactPropertyDeleted,
ContactPropertyUpdated,
ConversationAllUsersUnassigned,
ConversationClosed,
ConversationCreated,
ConversationDeleted,
ConversationLabelApplied,
ConversationLabelRemoved,
ConversationOpened,
ConversationUpdated,
ConversationUpdateLabelsAndUsers,
ConversationUsersAssigned,
EventCreated,
EventDeleted,
EventUpdated,
EventStreamWebhookReceived,
ExportCreated,
ExportShard,
ExportCompleted,
FilterCreated,
FilterDeleted,
FilterUpdated,
FlagCreated,
FlagDeleted,
FlagUpdated,
ImportCreated,
ImportShard,
ImportCompleted,
InboundCallWebhookReceived,
InboundChannelBlocked,
InboundChannelCreated,
InboundChannelDeleted,
InboundChannelUpdated,
InboundComplianceReplyRequest,
InboundMessageWebhookReceived,
InboundWebhookReceived,
InvitationCreated,
InvitationDeleted,
InvitationUpdated,
LabelCreated,
LabelDeleted,
LabelUpdated,
MediaCreated,
MediaDeleted,
MediaUpdated,
MessageBlocked,
MessageCreated,
MessageDeleted,
MessageDelivered,
MessageFailed,
MessageReceived,
MessageReceivedUserNotificationRequest,
MessageScheduled,
MessageScheduleDeleted,
MessageScheduleUpdated,
MessageSent,
MessageSendRequest,
MessageUpdated,
MessageDraftCreated,
MessageDraftDeleted,
MessageDraftUpdated,
MessagesExported,
MessageTagCreated,
MessageTagDeleted,
MessageTagUpdated,
MessageTemplateCreated,
MessageTemplateDeleted,
MessageTemplateUpdated,
MessageStatusWebhookReceived,
MigratePhoneBW,
MigrateFormattedPhoneBW,
MigrationV1Started,
MigrationV1Completed,
MigrationV1Download,
MigrationV1DownloadComplete,
MigrationV1ProcessContacts,
MigrationV1ProcessContactRow,
MigrationV1ProcessExtensionOptions,
MigrationV1ProcessExtensionOptionRow,
MigrationV1ProcessMessages,
MigrationV1ProcessMessageRow,
MigrationV1ProcessMessageTemplates,
MigrationV1ProcessMessageTemplateRow,
MigrationV1ProcessOptOuts,
MigrationV1ProcessOptOutRow,
OptOutCreated,
OptOutDeleted,
OptOutUpdated,
OutboundChannelCreated,
OutboundChannelDeleted,
OutboundChannelUpdated,
RelayCreated,
RelayDeleted,
RelayTriggered,
RelayUpdated,
ScheduleCreated,
ScheduleDeleted,
ScheduleUpdated,
SearchWorkspaceReindexRequest,
SigningSecretCreated,
SigningSecretDeleted,
StripeWebhookReceived,
StripeSubscriptionCanceled,
StripeSubscriptionUpdated,
SmsNumberCreated,
SmsNumberDeleted,
SmsNumberUpdated,
SubscriptionCreated,
SubscriptionDeleted,
SubscriptionUpdated,
TCRWebhookReceived,
TelgorithmPhoneNumberStatusWebhookReceived,
TenantCreated,
TenantUpdated,
TenantDeleted,
ThreadCreated,
ThreadUpdated,
ThreadDeleted,
Test,
UnreadConversationsCountUpdated,
UserConnected,
UserDisconnected,
UserCreated,
UserDeleted,
UserHasJoinedTheChannel,
UserHasLeftTheChannel,
UserLogin,
UserStartedTyping,
UserStoppedTyping,
UserUpdated,
UserMembershipCreated,
UserMembershipDeleted,
UserMembershipUpdated,
UserNotificationCreated,
UserNotificationDeleted,
UserNotificationUpdated,
UserRoleCreated,
UserRoleDeleted,
UserRoleUpdated,
UserSettingCreated,
UserSettingDeleted,
UserSettingUpdated,
WebhookSubscriptionCreated,
WebhookSubscriptionDeleted,
WorkspaceCreated,
WorkspaceDeleted,
WorkspaceMoved,
WorkspaceUpdated,
WorkspaceSettingCreated,
WorkspaceSettingDeleted,
WorkspaceSettingUpdated,
*
id
string

The unique identifier for the webhook

object
string

The object type

provider
enum<string>

The provider of the webhook

Available options:
zapier
tenant
object

Relationships

tenantId
string

The tenant id that this webhook belongs to

updatedAt
string
url
string

The URL of the webhook to send the request to

workspace
object
workspaceId
string

The workspace id that this webhook belongs to