Webhook

A webhook endpoint that receives events from the chats you are a member of, plus presence events for the users in your organization. Events are delivered as JSON POST requests to the endpoint URL.

  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string
    required

    An optional description of the endpoint.

  • disabled
    Type: boolean
    required

    Disabled endpoints do not receive events.

  • event_types
    Type: array of string | null
    required

    Event types this endpoint receives: message.created, message.updated, message.deleted, membership.created, membership.deleted, membership.updated, chat.updated, user.online, user.offline. null means all event types.

  • id
    Type: string
    required

    Unique identifier for the webhook endpoint.

  • tags
    Type: array of string | null
    required

    Tags this endpoint is limited to. Every message event is tagged with its chat (chat_{id}) and its sender (user_{id}). Membership events (membership.created, membership.deleted, membership.updated) are tagged with their chat (chat_{id}) and the member (user_{id}), and chat.updated with the chat (chat_{id}). Presence events (user.online, user.offline) are tagged with the user they describe (user_{id}). Events in a thread are tagged with the thread's parent chat plus the thread itself (thread_{id}), and events for messages that mention you are additionally tagged mentioned. A thread message's payload references the thread as its chat_id; GET /chats/{chat_id} returns the thread's parent_chat_id. null means the endpoint receives all events.

  • updated_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • url
    Type: stringFormat: uri
    required

    The URL events are delivered to.

Previous
Translation
Next
ApiToken