Docs
API referenceEvents

case.opened

Preview· P9

A service-recovery case opened on one of your page's reviews: by your team, by the page's rule (a 1 or 2 star review, or a serious topic), or by the customer answering your message. data.object is the case.

Agoo sends this as a signed POST to every enabled endpoint subscribed to case.opened (or *). Verify the signature, return any 2xx within 15 seconds, and de-duplicate on webhook-id.

Header Parameters

webhook-id*string

The event's ID. It is the same on every attempt and redelivery, so use it to de-duplicate.

Match^evt_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"evt_01m4ww0ezgf2bryg9gxb2gbewx"
webhook-timestamp*string

When this attempt was signed, in Unix seconds. Reject the request if it is more than 5 minutes from your clock.

Match^[0-9]+$
webhook-signature*string

One or more space-separated signatures, each v1,<base64>: the base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{raw body}, keyed with the base64-decoded part of your whsec_ secret. During a secret rotation there are two. Accept the request if any one matches.

Request Body

application/json
  1. body

An event about a service-recovery case on your page on Agoo Reviews.

id*EventId

The event's ID. Webhook deliveries send it as webhook-id.

Match^evt_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"evt_01m4ww0ezgf2bryg9gxb2gbewx"
created_at*string

When the event happened.

Formatdate-time
organisation_id*OrganisationId

An organisation ID (TypeID with the org prefix).

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"org_01kjpsrza0etzb0a4vf72x8ang"
livemode*boolean

false for events in test mode.

type*string
Value in"case.opened""case.updated""case.closed"
data*

Response Body

Return any 2xx status within 15 seconds to acknowledge the event. Agoo ignores the response body, so acknowledge first and do slow work afterwards.

Example Requests

POST/case.opened

item.removed Webhook

An item was taken off your page (`status: removed`). Reviews that name it keep doing so. Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `item.removed` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.

case.updated Webhook

A case changed: its state, its owner or due date, or the customer's own answer (`customer_outcome`). A business closing a case never sets the customer's answer. Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `case.updated` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.