Sign in
unified
webhook

Retrieve webhook by its ID

get/unified/webhook/{id}

Path parameters

idstring required

ID of the Webhook

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
workspace_idstring
connection_idstring required
hook_urlstring
object_type'accounting_account' | 'accounting_transaction' | 'accounting_journal' | 'accounting_contact' | 'accounting_invoice' | 'accounting_bill' | 'accounting_vendorcredit' | 'accounting_creditmemo' | 'accounting_taxrate' | 'accounting_paymentterm' | 'accounting_organization' | 'accounting_order' | 'accounting_salesorder' | 'accounting_salesreceipt' | 'accounting_purchaseorder' | 'accounting_balancesheet' | 'accounting_profitloss' | 'accounting_trialbalance' | 'accounting_category' | 'accounting_expense' | 'accounting_expensereport' | 'accounting_purchasereceipt' | 'accounting_cashflow' | 'accounting_quote' | 'accounting_agedreceivable' | 'accounting_agedpayable' | 'accounting_project' | 'accounting_bankfeedaccount' | 'accounting_bankfeedtransaction' | 'payment_payment' | 'payment_link' | 'payment_payout' | 'payment_refund' | 'payment_subscription' | 'commerce_item' | 'commerce_collection' | 'commerce_inventory' | 'commerce_location' | 'commerce_review' | 'commerce_saleschannel' | 'commerce_itemvariant' | 'commerce_reservation' | 'commerce_availability' | 'verification_package' | 'verification_request' | 'assessment_package' | 'assessment_order' | 'ats_activity' | 'ats_application' | 'ats_applicationstatus' | 'ats_candidate' | 'ats_document' | 'ats_interview' | 'ats_job' | 'ats_scorecard' | 'ats_company' | 'crm_company' | 'crm_contact' | 'crm_deal' | 'crm_event' | 'crm_lead' | 'crm_pipeline' | 'crm_taxonomy' | 'hris_employee' | 'hris_group' | 'hris_payslip' | 'hris_timeoff' | 'hris_company' | 'hris_location' | 'hris_device' | 'hris_timeshift' | 'hris_attendance' | 'hris_deduction' | 'hris_benefit' | 'hris_bankaccount' | 'hris_document' | 'hris_taxonomy' | 'martech_list' | 'martech_member' | 'martech_campaign' | 'martech_report' | 'passthrough' | 'ticketing_note' | 'ticketing_ticket' | 'ticketing_customer' | 'ticketing_category' | 'uc_contact' | 'uc_call' | 'uc_comment' | 'uc_recording' | 'enrich_person' | 'enrich_company' | 'storage_file' | 'genai_model' | 'genai_prompt' | 'genai_embedding' | 'genai_task' | 'genai_agent' | 'genai_organization' | 'messaging_message' | 'messaging_channel' | 'messaging_event' | 'kms_space' | 'kms_page' | 'kms_comment' | 'task_project' | 'task_task' | 'task_comment' | 'task_change' | 'scim_users' | 'scim_groups' | 'lms_course' | 'lms_class' | 'lms_student' | 'lms_instructor' | 'lms_content' | 'lms_collection' | 'lms_activity' | 'repo_organization' | 'repo_repository' | 'repo_branch' | 'repo_commit' | 'repo_pullrequest' | 'metadata_metadata' | 'calendar_calendar' | 'calendar_event' | 'calendar_busy' | 'calendar_link' | 'calendar_recording' | 'calendar_webinar' | 'ads_organization' | 'ads_ad' | 'ads_campaign' | 'ads_report' | 'ads_group' | 'ads_creative' | 'ads_asset' | 'ads_insertionorder' | 'ads_target' | 'ads_promoted' | 'analytics_property' | 'analytics_event' | 'analytics_session' | 'analytics_visitor' | 'analytics_report' | 'forms_form' | 'forms_submission' | 'shipping_carrier' | 'shipping_rate' | 'shipping_shipment' | 'shipping_label' | 'shipping_tracking' | 'signing_document' | 'signing_signatory' | 'signing_template' | 'clubs_group' | 'clubs_member' | 'clubs_activity' | 'clubs_location' | 'clubs_event' | 'datastore_database' | 'datastore_table' | 'datastore_record' | 'datastore_query' | 'cdp_profile' | 'cdp_segment' | 'cdp_event' | 'cdp_source' | 'cdp_destination' | 'cdp_activation' | 'performance_cycle' | 'performance_review' | 'performance_goal' | 'performance_feedback' | 'social_post' | 'social_profile' | 'social_review' | 'social_insight' required
intervalnumber
checked_atstring date-time
integration_typestring
environmentstring
event'updated' | 'created' | 'deleted' required
runsstring[]

An array of the most recent virtual webhook runs

fieldsstring
webhook_type'virtual' | 'native'
is_healthyboolean
page_max_limitnumber
filtersPropertyWebhookFilters

Supported on virtual webhooks, and on native webhooks for many integrations. Check the integration's Feature Support tab for which filters apply. Filters the integration doesn't support are accepted but have no effect. Some integrations require a filter; if it's missing, create returns an error naming the integration and the filter.

db_type'mongodb' | 'mysql' | 'postgres' | 'mssql' | 'mariadb' | 'supabase' | 'snowflake'
db_urlstring
db_schemastring
db_name_prefixstring
is_pausedboolean
is_betaboolean

Changes

Changed in 12 of the 34 revisions of this API.322

  • e0a7ff9259213See the full diff
    • ●

      added the new accounting_expensereport enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_purchasereceipt enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_salesreceipt enum value to the response property for the response status

      response-property-enum-value-added

  • 669f9277e1733See the full diff
    • ●

      added the new genai_agent enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new genai_organization enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new genai_task enum value to the response property for the response status

      response-property-enum-value-added

  • b837b009e30d1See the full diff
    • ○

      removed the accounting_report enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 88010aaae74e11See the full diff
    • ●

      added the new crm_taxonomy enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the crm_picklist enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1fbb53b883654See the full diff
    • ●

      added the new social_insight enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new social_post enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new social_profile enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new social_review enum value to the response property for the response status

      response-property-enum-value-added

  • 7db9bed891d21See the full diff
    • ●

      added the new accounting_paymentterm enum value to the response property for the response status

      response-property-enum-value-added

  • 734f619aa03e2See the full diff
    • ●

      added the new accounting_bankfeedaccount enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_bankfeedtransaction enum value to the response property for the response status

      response-property-enum-value-added

  • 1c744a7590b41See the full diff
    • ●

      added the new hris_attendance enum value to the response property for the response status

      response-property-enum-value-added

  • 021e9b45420a4See the full diff
    • ●

      added the new performance_cycle enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new performance_feedback enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new performance_goal enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new performance_review enum value to the response property for the response status

      response-property-enum-value-added

  • 1f72720916e44See the full diff
    • ●

      added the new accounting_agedpayable enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_agedreceivable enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_project enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new accounting_quote enum value to the response property for the response status

      response-property-enum-value-added