Interface WebhooksSchemaDefinition

Webhook request

interface WebhooksSchemaDefinition {
    id: string;
    payload: CustomerGroupChangedPayload | CustomerChangedPayload | CustomerGroupMembershipsChangedPayload | TimelineEntryChangedPayload | ThreadCreatedPublicEventPayload | ThreadStatusTransitionedPublicEventPayload | ThreadAssignmentTransitionedPublicEventPayload | ThreadEmailReceivedPublicEventPayload | ThreadEmailSentPublicEventPayload | ThreadLabelsChangedPublicEventPayload | ThreadPriorityChangedPublicEventPayload | ThreadFieldCreatedPublicEventPayload | ThreadFieldUpdatedPublicEventPayload | ThreadFieldDeletedPublicEventPayload | ThreadChatSentPublicEventPayload | ThreadServiceLevelAgreementStatusTransitionedPayload | CustomerCreatedPublicEventPayload | CustomerUpdatedPublicEventPayload | CustomerDeletedPublicEventPayload;
    timestamp: string;
    type: "customer.customer_group_changed" | "thread.thread_created" | "thread.thread_status_transitioned" | "thread.thread_assignment_transitioned" | "thread.email_received" | "thread.email_sent" | "thread.chat_sent" | "thread.note_created" | "thread.thread_labels_changed" | "thread.thread_priority_changed" | "thread.thread_field_created" | "thread.thread_field_updated" | "thread.thread_field_deleted" | "thread.service_level_agreement_status_transitioned" | "customer.customer_created" | "customer.customer_updated" | "customer.customer_deleted" | "customer.customer_changed" | "customer.customer_group_memberships_changed" | "timeline.timeline_entry_changed";
    webhookMetadata: {
        webhookDeliveryAttemptId: string;
        webhookDeliveryAttemptNumber: number;
        webhookDeliveryAttemptTimestamp: string;
        webhookTargetId: string;
    };
    workspaceId: string;
}

Properties

id payload timestamp type webhookMetadata workspaceId

Properties

id

id: string

payload

payload: CustomerGroupChangedPayload | CustomerChangedPayload | CustomerGroupMembershipsChangedPayload | TimelineEntryChangedPayload | ThreadCreatedPublicEventPayload | ThreadStatusTransitionedPublicEventPayload | ThreadAssignmentTransitionedPublicEventPayload | ThreadEmailReceivedPublicEventPayload | ThreadEmailSentPublicEventPayload | ThreadLabelsChangedPublicEventPayload | ThreadPriorityChangedPublicEventPayload | ThreadFieldCreatedPublicEventPayload | ThreadFieldUpdatedPublicEventPayload | ThreadFieldDeletedPublicEventPayload | ThreadChatSentPublicEventPayload | ThreadServiceLevelAgreementStatusTransitionedPayload | CustomerCreatedPublicEventPayload | CustomerUpdatedPublicEventPayload | CustomerDeletedPublicEventPayload

timestamp

timestamp: string

type

type: "customer.customer_group_changed" | "thread.thread_created" | "thread.thread_status_transitioned" | "thread.thread_assignment_transitioned" | "thread.email_received" | "thread.email_sent" | "thread.chat_sent" | "thread.note_created" | "thread.thread_labels_changed" | "thread.thread_priority_changed" | "thread.thread_field_created" | "thread.thread_field_updated" | "thread.thread_field_deleted" | "thread.service_level_agreement_status_transitioned" | "customer.customer_created" | "customer.customer_updated" | "customer.customer_deleted" | "customer.customer_changed" | "customer.customer_group_memberships_changed" | "timeline.timeline_entry_changed"

webhookMetadata

webhookMetadata: {
    webhookDeliveryAttemptId: string;
    webhookDeliveryAttemptNumber: number;
    webhookDeliveryAttemptTimestamp: string;
    webhookTargetId: string;
}

Type declaration

  • webhookDeliveryAttemptId: string
  • webhookDeliveryAttemptNumber: number
  • webhookDeliveryAttemptTimestamp: string
  • webhookTargetId: string

workspaceId

workspaceId: string

Settings

Member Visibility

Theme

On This Page

idpayloadtimestamptypewebhookMetadataworkspaceId

Generated using TypeDoc