Overhaul & Extend Webhooks

[kirrg001]

Alongside the API v2 and new auth mechanisms we'll be extend our webhooks feature.

Payload

We are currently using the following format:

e.g.

subscribers: [subscriber-model]

We would like to change this format, because we want to make it simpler to consume and we would like to expose changed fields. Furthermore the old format was not API compliant. We have simply introduced a new webhooks field schema, which we should not, because it means we have to A) maintain two formats and B) we could potentially expose fields which are removed on the API level.

The new payload needs to run through the target configured API version (output serialization) to ensure the same field output than the target API version.

resource: {
  current: attributes,
  previous: attributes
}

resource.attributes will only list the fields, which have changed.

IMPORTANT: We won't break the existing events. We will support both formats for a while. We will maybe drop the old format in v3.

New Webhooks

• Posts

  • post.added
  • post.deleted
  • post.edited
  • post.published
  • post.published.edited
  • post.unpublished
  • post.scheduled
  • post.unscheduled
  • post.rescheduled

• Pages

  • page.added
  • page.deleted
  • page.edited
  • page.published
  • page.published.edited
  • page.unpublished
  • page.scheduled
  • page.unscheduled
  • page.rescheduled

• Tags

  • tag.added
  • tag.edited
  • tag.deleted
  • post.tag.``attached
  • post.tag.``detached
  • page.tag.attached
  • page.tag.detached

Security

Coming soon...

---

Tasks

• refactor webhook service to use API serializers
• re-work payload format including current & previous attrs
• add new webhooks
• add security concept

Please don't rely on the new available implementation in master till we announce the feature.

[kevinansfield]

Closing in favour of specific issues for any future enhancements 🎉