SmartTask Developers
Main Website
  • Overview
  • Authentication
    • Basics
    • Details
  • Endpoints
    • Organization
      • Fetch Organizations
    • Task
      • Create a Task
    • Record Activity
      • Fetch Activities
      • Add Comment
    • Project
      • Fetch Projects
    • Organization User
      • Filter Users
    • Webhooks
      • Subscribe to an Event
      • Unsubscribe from a Webhook
  • Models
    • Organization
      • Organization User
    • Group
    • Project
    • Record
    • Record Activity
    • Task
    • Contact
    • Webhook
    • Membership
    • File
    • Custom Field
      • Custom Field Value
    • User
Powered by GitBook
On this page
  1. Models

Webhook

{
  webhook_id?:        number | null;      // DB id (nullable)
  target_url:         string;             // required
  event_type:         WebhookTypeEnum;    // required – see enum below

  organization_id?:   number | null;
  project_id?:        string | null;      // GUID-as-string
  custom_field_id?:   string | null;      // GUID-as-string
}

WebhookType Enum


{
    contact_created = "contact_created",    //Requires organization_id
    contact_custom_field_value_updated = "contact_custom_field_value_updated",    //Requires organization_id, custom_field_id
        
    project_custom_field_updated = "project_custom_field_updated",    //Requires organization_id, custom_field_id
        
    task_project_added = "task_project_added",    //Requires organization_id, project_id
    task_custom_field_value_updated = "task_custom_field_value_updated",    //Requires organization_id, project_id, custom_field_id
    task_commented = "task_commented",    //Requires organization_id, project_id
    task_completed = "task_completed",    //Requires organization_id, project_id
    task_reminder = "task_reminder",    //Triggers on reminder date - Requires organization_id, project_id
}
PreviousContactNextMembership

Last updated 7 days ago