Overview of Ryver outbound webhooks

Outbound Webhooks

Outbound webhooks allow you to track events that occur in Ryver, and trigger actions in other applications and services. Ryver Enterprise customers can also use outbound webhooks to trigger their workflows. Currently, outbound webhooks support is in private beta. Please contact support if you would like access.

Events currently included in the outbound webhook support:

Chat

  • Chat Message Created
  • Chat Message Edited
  • Chat Message Removed

Tasks

  • Task created
  • Task edited
  • New assignee
  • Completed
  • Due Date added
  • Task removed
  • Task comment created
  • Task comment removed
  • Category created
  • Category edited
  • Category removed
  • Task Board created
  • Task Board edited
  • Task Board removed

Topics

  • Topic created
  • Topic edited
  • Topic removed
  • Topic reply created
  • Topic reply removed

Users

  • User created
  • User edited
  • User invited
  • User accepted invite
  • User deactivated

Webhook payload

The webhook payload will vary depending on the event. A great way to test out the webhooks is to use a service such as https://webhook.site. Here are some example webhook event payloads:

Chat Message Created (chat_created)

{
  "type": "chat_created",
  "timestamp": "2018-12-12T17:16:39+00:00",
  "user": {
    "__metadata": {
      "type": "Entity.User"
    },
    "id": 100000,
    "__descriptor": "Jeff"
  },
  "data": {
    "entity": {
      "__metadata": {
        "type": "Entity.ChatMessage"
      },
      "id": "000000000000000",
      "createSource": null,
      "createDate": "2018-12-12T17:16:39+00:00",
      "message": "Hi"
    },
    "channel": {
      "__metadata": {
        "type": "Entity.Workroom"
      },
      "id": 1000125,
      "__descriptor": "Jeff's Whiteboard"
    }
  }
}

Topic Created (post_created)

{
  "type": "post_created",
  "timestamp": "2018-12-12T17:20:59+00:00",
  "user": {
    "__metadata": {
      "type": "Entity.User"
    },
    "id": 1000000,
    "__descriptor": "Jeff"
  },
  "data": {
    "entity": {
      "__metadata": {
        "type": "Entity.Post"
      },
      "id": 1000000,
      "__descriptor": "Example Topic",
      "createUser": {
        "__metadata": {
          "type": "Entity.User"
        },
        "id": 1000000,
        "__descriptor": "Jeff"
      },
      "createDate": "2018-12-12T17:20:58+00:00",
      "createSource": null,
      "recordType": "note",
      "subject": "Example Topic",
      "body": "This is the topic description.\n\nWith some **markdown**."
    },
    "channel": {
      "__metadata": {
        "type": "Entity.Workroom"
      },
      "id": 1000125,
      "__descriptor": "Jeff's Whiteboard"
    }
  }
}

Topic Reply Created (postcomment_created)

{
  "type": "postcomment_created",
  "timestamp": "2018-12-12T17:22:38+00:00",
  "user": {
    "__metadata": {
      "type": "Entity.User"
    },
    "id": 1000000,
    "__descriptor": "Jeff"
  },
  "data": {
    "entity": {
      "__metadata": {
        "type": "Entity.Post.Comment"
      },
      "id": 1000000,
      "__descriptor": "This is my topic reply.",
      "createUser": {
        "__metadata": {
          "type": "Entity.User"
        },
        "id": 1000000,
        "__descriptor": "Jeff"
      },
      "createDate": "2018-12-12T17:22:38+00:00",
      "createSource": null,
      "comment": "This is my topic reply.",
      "post": {
        "__metadata": {
          "type": "Entity.Post"
        },
        "id": 1000000,
        "__descriptor": "Example Topic"
      }
    },
    "channel": {
      "__metadata": {
        "type": "Entity.Workroom"
      },
      "id": 1000000,
      "__descriptor": "Jeff's Whiteboard"
    }
  }
}

Task Created (task_created)

{
  "type": "task_created",
  "timestamp": "2018-12-12T17:25:48+00:00",
  "user": {
    "__metadata": {
      "type": "Entity.User"
    },
    "id": 1000000,
    "__descriptor": "Jeff"
  },
  "data": {
    "entity": {
      "__metadata": {
        "type": "Entity.Tasks.Task"
      },
      "id": 1000000,
      "__descriptor": "Example Task",
      "createUser": {
        "__metadata": {
          "type": "Entity.User"
        },
        "id": 1000000,
        "__descriptor": "Jeff"
      },
      "createDate": "2018-12-12T17:25:48+00:00",
      "createSource": null,
      "subject": "Example Task",
      "body": "This is the task description",
      "position": 7,
      "tags": [
        "test"
      ],
      "short": "WB-59",
      "dueDate": "2018-12-13T19:00:00+00:00",
      "completeDate": null,
      "archived": false,
      "category": {
        "__metadata": {
          "type": "Entity.Tasks.TaskCategory"
        },
        "id": 1000000,
        "__descriptor": "Test Category"
      },
      "parent": null,
      "assignees": {
        "results": [
          {
            "__metadata": {
              "type": "Entity.User"
            },
            "id": 1000000,
            "__descriptor": "Jeff"
          }
        ]
      },
      "board": {
        "__metadata": {
          "type": "Entity.Tasks.TaskBoard"
        },
        "id": 1000000,
        "__descriptor": "Jeff's Whiteboard"
      }
    },
    "channel": {
      "__metadata": {
        "type": "Entity.Workroom"
      },
      "id": 1000000,
      "__descriptor": "Jeff's Whiteboard"
    }
  }
}

Task Edited (task_updated)

{
  "type": "task_updated",
  "timestamp": "2018-12-12T17:29:22+00:00",
  "user": {
    "__metadata": {
      "type": "Entity.User"
    },
    "id": 1000000,
    "__descriptor": "Jeff"
  },
  "data": {
    "entity": {
      "__metadata": {
        "type": "Entity.Tasks.Task"
      },
      "id": 1000000,
      "__descriptor": "Example Task",
      "createUser": {
        "__metadata": {
          "type": "Entity.User"
        },
        "id": 1000000,
        "__descriptor": "Jeff"
      },
      "createDate": "2018-12-12T17:25:48+00:00",
      "createSource": null,
      "subject": "Example Task",
      "body": "This is the task description",
      "position": 0,
      "tags": [
        "test"
      ],
      "short": "WB-59",
      "dueDate": "2018-12-13T19:00:00+00:00",
      "completeDate": null,
      "archived": false,
      "category": {
        "__metadata": {
          "type": "Entity.Tasks.TaskCategory"
        },
        "id": 1000000,
        "__descriptor": "New cat"
      },
      "parent": null,
      "assignees": {
        "results": [
          {
            "__metadata": {
              "type": "Entity.User"
            },
            "id": 1000000,
            "__descriptor": "Jeff"
          }
        ]
      },
      "board": {
        "__metadata": {
          "type": "Entity.Tasks.TaskBoard"
        },
        "id": 1000000,
        "__descriptor": "Jeff's Whiteboard"
      }
    },
    "changes": {
      "position": {
        "old": 7
      },
      "category": {
        "old": {
          "__metadata": {
            "type": "Entity.Tasks.TaskCategory"
          },
          "id": 1000000,
          "__descriptor": "Test Category"
        }
      }
    },
    "channel": {
      "__metadata": {
        "type": "Entity.Workroom"
      },
      "id": 1000000,
      "__descriptor": "Jeff's Whiteboard"
    }
  }
}