Skip to content

[CAL-2904] Request to add 2 Fields to Webhook Payloads #12415

@henrym9345

Description

@henrym9345

Is your proposal related to a problem?

I'm using the webhooks to trigger appointment reminders (internal and external) from our marketing automation tool rather than use built in reminders.

Problem 1: I want to include cancel and reschedule links in these messages which require the url slug, which is not present in the webhook. The current workaround is to maintain a collection that contains the url slug and event type ID. This is called upon in the messaging workflow and a slug is obtained that matches the event type ID in the webhook. This is suboptimal though because this collection must be maintained as new events are added, slugs can be somewhat easily changed from cal.com and it just adds additional steps.

Problem 2:Timestamps for the appointments must be in the correct timezone on all messages. Since the payload only provides UTC time, a conversion must be performed using Liquid tags. This requires a UTC offset (ie -7), so the timezone string (ie America/Los Angeles) must be matched to provide this. This is done with a similar method as described in Problem 1. To make matters more complicated our local timezone of America/Phoenix does not observe daylight savings, so the offset will switch between -7 and -8. This adds the need for additional logic to check the current date before performing the timezone conversion.

Describe the solution you'd like

Solution for Problem 1: Add a field for url slug to the webhook payload

Solution for Problem 2:
Option 1: Add the attendee UTC offset (ie -7) as a field, rather than the string of the timezone.
Option 2: Add a timestamp field where the timestamp is already matches the timezone setting of the appointment.

(Describe your proposed solution here.)

Describe alternatives you've considered

Possible alternative for Problem 1: Use url parameters+ a hidden field to pass through the slug. Not particularly stable though.

Additional context

NA

Requirement/Document

NA


House rules
  • If this issue has a 🚨 needs approval label, don't start coding yet. Wait until a core member approves feature request by removing this label, then you can start coding.
    • For clarity: Non-core member issues automatically get the 🚨 needs approval label.
    • Your feature ideas are invaluable to us! However, they undergo review to ensure alignment with the product's direction.

CAL-2904

Metadata

Metadata

Assignees

No one assigned

    Labels

    Medium priorityCreated by Linear-GitHub Syncapiarea: API, enterprise API, access token, OAuthlinearSync Github Issue from community members to Linear.appwebhooksarea: webhooks, callback, webhook payload✨ featureNew feature or request💎 BountyA bounty on Algora.io💰 RewardedRewarded bounties on Algora.io

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions