Developers
Webhooks

🪝 Webhooks

With webhooks, the world of automation is at your fingertips! Admins can find webhook settings in the Developers module on the App Home.

Accessing Webhooks

Admins can view and register their webhooks with Tightknit by clicking the Webhooks button.

Webhooks List

Register a new Webhook

Click the + Create Webhook button to register your webhook with Tightknit. Once registered, you will be able to use this webhook as a data endpoint within various other Tightknit modules.

Webhooks require the following fields:

  • Name - a helpful name to identify your webhook
  • URL - the URL endpoint for your webhook
  • Subscriptions - the events or actions that your webhook listens for

Delete a Webhook

Delete webhook option

To delete a webhook, click the ••• next to the list item and select the Delete option.

You will be restricted from deleting a webhook if it is currently in use within a Tightknit module. You must remove all references to the webhook before you can delete it.

Subscriptions

Your webhook can subscribe, or listen, to any number of events emitted by Tightknit. The following events are currently supported.

Calendar Events

Actions emitted related to Calendar Events (not to be confused with webhook "events").

Event User Registration

Emitted when a user registers for a Calendar Event. Includes the "Webhook Custom Metadata" in the custom_metadata field, if configured for the Calendar Event.

{
  version: string;
  action: string;
  status: 'registered';
  date: string;
  custom_metadata?: string | null;
  event: {
    id: string;
    title: string;
    slug: string;
  };
  source: {
    slack_workspace_id: string;
    slack_channel_id?: string;
  };
  user: {
    id: string;
    first_name: string;
    last_name: string;
    real_name: string;
    display_name: string;
    email: string;
    profile_fields: {
      [FIELD_API_NAME]: {
        label: string;
        value: string;
      };
    };
  };
}

Event User Un-registration

Emitted when a user un-registers from a Calendar Event. Includes the "Webhook Custom Metadata" in the custom_metadata field, if configured for the Calendar Event.

{
  version: string;
  action: string;
  status: 'unregistered';
  date: string;
  custom_metadata?: string | null;
  event: {
    id: string;
    title: string;
    slug: string;
  };
  source: {
    slack_workspace_id: string;
    slack_channel_id?: string;
  };
  user: {
    id: string;
    first_name: string;
    last_name: string;
    real_name: string;
    display_name: string;
    email: string;
    profile_fields: {
      [FIELD_API_NAME]: {
        label: string;
        value: string;
      };
    };
  };
}
More subscription events coming soon!