Tycka supports real time updates for integrations in the form of webhooks (POST requests).

Multiple webhooks can be registered for each type and they might get executed in parallel.

Webhooks are registered using the addOrUpdateWebhook mutation. Custom headers can be configured to be sent together with the POST request, useful for authentication.

mutation createWebhook {
  addOrUpdateWebhook(
    id: "example_REVIEW_UPDATED"
    headers: [
      { key: "auth_token", value: "token"}
    ]
    type: REVIEW_UPDATED
    url: "<https://example.com>"
  )
}

Webhooks are removed using the removeWebhookmutation:

mutation removeWebhook {
  removeWebhook(id: "example_REVIEW_UPDATED")
}

Webhook Types

ReviewUpdated

This webhook fires every time a review has been updated and indexed into the private search index. Change might not yet be visible to the public search index, which means that one should use the authenticated private search index to act on these events.

<aside> 🚨 If item1 is connected to review1, and item1 is updated. Then review1 will be updated in the search index and therefor the ReviewUpdated webhook will fire. This will most likely be changed in the future, if your solution depend on this existing behavior, please get in contact with us.

</aside>

PPE

This webhook fires according to the transaction’s PPE schedule, or if absent your account’s global PPE schedule.