POST/desk/api/v2/conversationmessages/webhooks.json

This endpoint is used by pusher to send bulk events to desk via webhooks.

This is not a public endpoint.

Body Params

ConversationMessage represents a ConversationMessage.

    • Name
      contactId
      Type
      integer
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      files
      Type
      array
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      message
      Type
      string
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object
    • Name
      userId
      Type
      integer

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      ConversationMessageAPIBody handles the get/create/update request/response for conversationmessage.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    ConversationMessageAPIBody
    {  "conversationmessage": {    "contactId": 0,    "createdAt": "2024-12-19T16:02:34.120Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2024-12-19T16:02:34.120Z",    "deletedBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"
    Download Swagger