search

ably / docs

Ably Realtime API documentation
https://ably.com/docs
Apache License 2.0
20 stars 41 forks source link

Integrations: Add note around webhook data envelope support #2269

Closed splindsay-92 closed 1 month ago

splindsay-92 commented 1 month ago

NOTE TO REVIEWERS - please do not review PRs in the DRAFT state, as the PR may change substantially before it is ready to review. Thanks.

Description

When creating a new Webhook integration rule, it wasn't obvious that only message and presence events can be sent as raw payload in webhooks. Trying to do the same with occupancy or lifecycle events would generate an error when trying to create the rule. I have added a small section to the docs to make this clearer, in the hopes we will avoid future confusion.

Review

Instructions on how to review the PR.

mclark-ably commented 1 month ago

It is probably worth mentioning that when creating the rule on the integrations dashboard unselecting enveloped will therefore result in an error

This should have a review from deved team

m-hulbert commented 1 month ago

It is probably worth mentioning that when creating the rule on the integrations dashboard unselecting enveloped will therefore result in an error

This should have a review from deved team

@mclark-ably I think a better UX would be if we disabled the functionality in the dashboard based on which source you select. I've pushed a few minor changes, if everyone is happy with those then I'll merge 🙂

mclark-ably commented 1 month ago

It is probably worth mentioning that when creating the rule on the integrations dashboard unselecting enveloped will therefore result in an error This should have a review from deved team

@mclark-ably I think a better UX would be if we disabled the functionality in the dashboard based on which source you select. I've pushed a few minor changes, if everyone is happy with those then I'll merge 🙂

Thanks @m-hulbert , I agree but I don't know what the complexities are around this and would need to be a web team task (see internal comment https://ably-real-time.slack.com/archives/C8SPU4589/p1725986843113469?thread_ts=1725965046.845339&cid=C8SPU4589)

m-hulbert commented 1 month ago

It is probably worth mentioning that when creating the rule on the integrations dashboard unselecting enveloped will therefore result in an error This should have a review from deved team

@mclark-ably I think a better UX would be if we disabled the functionality in the dashboard based on which source you select. I've pushed a few minor changes, if everyone is happy with those then I'll merge 🙂

Thanks @m-hulbert , I agree but I don't know what the complexities are around this and would need to be a web team task (see internal comment https://ably-real-time.slack.com/archives/C8SPU4589/p1725986843113469?thread_ts=1725965046.845339&cid=C8SPU4589)

I'm going to merge this and let's pick that up separately in Slack.