Skip to content
Office

Office Engage feature

API and webhooks

A REST API for everything in Engage, and signed webhooks for every post, vote, comment and update.

REST API

With an API key you can list boards; create, update, merge and change the status of posts (with or without notifying voters); add votes on behalf of customers; read and write comments; find and update end users and companies; and create, schedule and publish changelog entries. JSON in and out, with cursor pagination.

Webhooks

Get a signed POST when a post is created, updated, merged, deleted or changes status, when a vote or comment is added or removed, when an update is published or unpublished, and when someone subscribes. Failed deliveries are retried. Point a Zapier or Make catch hook at it to connect anything.

Example

Ideas from your help desk

A support team adds a "Feature request" button to its help desk that calls the API with the customer's email and the idea's id. The vote lands with a note holding the ticket link, and when the idea ships, a webhook on post.status_changed posts the news back on the ticket.

How to set it up

  1. 1

    Go to Settings, API keys and create a key.

  2. 2

    Call the API with the key in the Authorization header.

  3. 3

    Go to Settings, Webhooks, add your URL and pick events.

  4. 4

    Check the signature header on each delivery.

API and webhooks is part of Office Engage and included on every plan.

Try Office Engage with your whole team

7-day trial with every feature. Cancel from the billing page whenever you like.