> ## Documentation Index
> Fetch the complete documentation index at: https://botpress-ak-docs-20-document-updating-variables-from-outsid.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Workable

> Add a bot to Workable using the official integration.

export const OpenInHub = ({integration}) => {
  const {version, id} = integration || ({});
  const basePath = 'https://studio.botpress.cloud/home?exploreHub=1&hubItemId=';
  const url = `${basePath}${id}`;
  return <>
            <a className="button rounded-xl" href={url}>
                <span>
                Open in Hub
                </span>
            </a>
            <i style={{
    margin: "0",
    fontStyle: "normal",
    color: "#666",
    fontSize: "0.85rem",
    padding: '.5rem'
  }}>
                v{version}
            </i>
        </>;
};

export const integrationVersions = {
  "accelo": {
    "version": "2.0.0",
    "id": "intver_01JFAQHPVKP4XTKMNXC2RZKZ88"
  },
  "activecampaign": {
    "version": "2.0.0",
    "id": "intver_01JFAQHVA0Z25PFC7H13EQ41FR"
  },
  "acumatica": {
    "version": "2.0.0",
    "id": "intver_01JFAQHZTNGNHPPS9CKD35Q6EY"
  },
  "airtable": {
    "version": "1.0.1",
    "id": "intver_01K9SVDSQMTXJMY4M8YCV5P5M1"
  },
  "alchemer": {
    "version": "2.0.0",
    "id": "intver_01JFAQQZRS9ZQ7WBWHCF1MKGCM"
  },
  "anthropic": {
    "version": "12.0.1",
    "id": "intver_01K9SVE54HWYN9RMC26G05J3WX"
  },
  "anydesk": {
    "version": "2.0.0",
    "id": "intver_01JFAQR4048H4976FCKT2YHD2X"
  },
  "apollo": {
    "version": "3.0.2",
    "id": "intver_01K6BJFKR5WZV44VNENAN6XBT1"
  },
  "asana": {
    "version": "0.3.10",
    "id": "intver_01KEYXKM7BZ7DDF9QJDQDE8H46"
  },
  "attio": {
    "version": "1.0.0",
    "id": "intver_01K6DMEM4B00RRDYF1KPRK3T1N"
  },
  "avoma": {
    "version": "2.0.0",
    "id": "intver_01JFAQRC955G4CXN8QTFHXAPXZ"
  },
  "bamboohr": {
    "version": "2.0.3",
    "id": "intver_01KESBCSC0N9WGPHNM1W1R08VK"
  },
  "beehiiv": {
    "version": "2.0.0",
    "id": "intver_01JFAQRGRRB95YC5YKWB1BFHZH"
  },
  "bigcommerce": {
    "version": "3.2.0",
    "id": "intver_01K3KNZ6CCCZ8E95G5ZGF5QV2J"
  },
  "bigin": {
    "version": "2.0.0",
    "id": "intver_01JFAQRS4Q0AY8CEAGYTDMPEPV"
  },
  "bolt": {
    "version": "2.0.0",
    "id": "intver_01JFAQRXGEVSFY1PYM195NAWQ6"
  },
  "box": {
    "version": "2.0.0",
    "id": "intver_01JFAQS1NBSGECDYX5MTTFN7RK"
  },
  "braze": {
    "version": "2.0.0",
    "id": "intver_01JFAQS5V6T5HF7MRJ46NMP42B"
  },
  "brevo": {
    "version": "2.0.0",
    "id": "intver_01JFAQSA1R5F1JGJZS55VTC1RP"
  },
  "britive": {
    "version": "2.0.0",
    "id": "intver_01JFAQSE7EMRGQE8EQD2CB6AZR"
  },
  "browser": {
    "version": "0.8.3",
    "id": "intver_01KCPVZG26185R8HFXCMEWBQZR"
  },
  "bynder": {
    "version": "2.0.0",
    "id": "intver_01JFAQSJT5N0Q2J2K7KGG12QQ5"
  },
  "calcom": {
    "version": "0.4.0",
    "id": "intver_01K3RNX07M9B21NA3PWJQ4D14H"
  },
  "calendly": {
    "version": "0.0.1",
    "id": "intver_01K4QXYC4K6PAHQ7J1AGHH1682"
  },
  "canny": {
    "version": "0.2.0",
    "id": "intver_01K5VH8AR6CKTRDRSVP99WDJN7"
  },
  "capsule-crm": {
    "version": "2.0.0",
    "id": "intver_01JFAQSQ6CJJ6G9FK7PAACKE6X"
  },
  "cerebras": {
    "version": "8.0.1",
    "id": "intver_01K9TCHXCG6K7RFRSJSQ3T2Q2P"
  },
  "charts": {
    "version": "0.2.6",
    "id": "intver_01KEYXM4W8FFZNQR97641ZGYYX"
  },
  "chat": {
    "version": "0.7.4",
    "id": "intver_01KBFTKJ7841MVQTYFRT623SP5"
  },
  "checkout": {
    "version": "2.0.0",
    "id": "intver_01JFAQSVA80GG51V7QKTARFG0E"
  },
  "clari": {
    "version": "2.0.0",
    "id": "intver_01JFAQSZVXNWXV8371M8ACEPFV"
  },
  "clay": {
    "version": "2.0.0",
    "id": "intver_01JFAQT424E25GR5K1Q8PZC4SC"
  },
  "clickup": {
    "version": "0.0.1",
    "id": "intver_01JEEWCGZ9QPQCBWVE95CMZ5PS"
  },
  "close": {
    "version": "2.0.0",
    "id": "intver_01JFAQT8BMZG66DNJM1DBZ2EQ3"
  },
  "cognism": {
    "version": "2.0.0",
    "id": "intver_01JFAQTCC9XR5N28RA4SNZ8KYJ"
  },
  "comeet": {
    "version": "2.0.0",
    "id": "intver_01JFAQTGMDYR086FC0VEQ95VGC"
  },
  "confluence": {
    "version": "3.3.2",
    "id": "intver_01JZAY7V5PMF8HX7FDMM9JZTQX"
  },
  "copper": {
    "version": "2.0.0",
    "id": "intver_01JFAQTS5YQTVNMSRMTH12X4YC"
  },
  "creatio": {
    "version": "2.0.0",
    "id": "intver_01JFAQTXY9Z4S1XDWSBT4J4KJJ"
  },
  "crmone": {
    "version": "2.0.0",
    "id": "intver_01JFAQV28DCXF7SV71N9Q5BJC8"
  },
  "dalle": {
    "version": "0.3.5",
    "id": "intver_01KA00BFXTW8APN0A0T8C023F1"
  },
  "databricks": {
    "version": "0.0.4",
    "id": "intver_01JBMK24H270H1ZTH2E8P34V4J"
  },
  "demandbase": {
    "version": "2.0.0",
    "id": "intver_01JFAQV9ZZ9MHH2ENEQ1ERMY2G"
  },
  "discord": {
    "version": "0.3.2",
    "id": "intver_01J3E7AN39P65XZ0Z00C1ZAHJ9"
  },
  "docusign": {
    "version": "2.0.0",
    "id": "intver_01JFAQVKFW4F7BBRSDD7EEZE6Z"
  },
  "dropbox": {
    "version": "1.2.0",
    "id": "intver_01JV5ED268ZJ8WQGVCKJZT2QPW"
  },
  "email": {
    "version": "0.1.0",
    "id": "intver_01K22SS8XNF58PQS42G1GGTK58"
  },
  "enchant": {
    "version": "2.0.0",
    "id": "intver_01JFAQVQQ60DZV01V3D1GA29YG"
  },
  "engagebay": {
    "version": "2.0.0",
    "id": "intver_01JFAQVVW42J4KNWCEZ6VQ3ZSJ"
  },
  "fathom": {
    "version": "2.0.0",
    "id": "intver_01JFAQW0QPEJS7M4EPVN9GJJDK"
  },
  "feature-base": {
    "version": "1.0.0",
    "id": "intver_01K5CVJXDNHM9K8NY3G2HWK5ZP"
  },
  "fireworks-ai": {
    "version": "10.0.1",
    "id": "intver_01KA00C056YZ050NMGZ91RMK95"
  },
  "fivetran": {
    "version": "2.0.0",
    "id": "intver_01JFAQW55482FWTDSPCYT53DWE"
  },
  "flodesk": {
    "version": "2.0.0",
    "id": "intver_01JFAQW9APE7Z8E81T2F58VDM7"
  },
  "folk": {
    "version": "2.0.0",
    "id": "intver_01JFAQWDVG2DVFYKJRD8DMHVPZ"
  },
  "freshchat": {
    "version": "1.5.3",
    "id": "intver_01KBFTM9H8CW7B7AV6W7K02CZW"
  },
  "freshsales": {
    "version": "2.0.0",
    "id": "intver_01JFAQWJ3CC3DJ5KG0W6XP33FD"
  },
  "fullstory": {
    "version": "2.0.0",
    "id": "intver_01JFAQWPM0T9EH5SAGDQ3Z14ZC"
  },
  "gainsight": {
    "version": "2.0.0",
    "id": "intver_01JFAQWTPKB13Y7619A6GEN5HQ"
  },
  "getaccept": {
    "version": "2.0.0",
    "id": "intver_01JFAQWZ0SAMDJVQNNA86RG21M"
  },
  "getresponse": {
    "version": "2.0.0",
    "id": "intver_01JFAQX34P2PBW0EM9NC6ZGFT5"
  },
  "github": {
    "version": "1.1.6",
    "id": "intver_01KB60MMABAE5CB0MWN2DY6RKK"
  },
  "gladly": {
    "version": "2.0.0",
    "id": "intver_01JFAQX7B29WE85VA8N5BCST16"
  },
  "gmail": {
    "version": "1.0.4",
    "id": "intver_01KF3MA6855SMVM708B30XRM4S"
  },
  "google-ai": {
    "version": "6.0.4",
    "id": "intver_01KA00CCZVWJQDB5SJ2MSJ4YEW"
  },
  "googlecalendar": {
    "version": "2.0.6",
    "id": "intver_01KCPW0RPJR7X6ATK55RP460VZ"
  },
  "googledrive": {
    "version": "0.3.4",
    "id": "intver_01K6Y3PR2TP9BQEX5PHBGEQD2H"
  },
  "groq": {
    "version": "15.0.1",
    "id": "intver_01KA00CS53WFYF70K16AEZFZXW"
  },
  "gsheets": {
    "version": "2.1.0",
    "id": "intver_01KF14JG57MFAZCXX1CS2T07FQ"
  },
  "gusto": {
    "version": "2.0.0",
    "id": "intver_01JFAR75Y17N5EWS6P0PC93RHQ"
  },
  "happyfox": {
    "version": "2.0.0",
    "id": "intver_01JFAQXFNYWCXX819GTBHJ470W"
  },
  "help-scout": {
    "version": "2.0.0",
    "id": "intver_01JFAQXKX61YWJMMHYK3YDFZ0K"
  },
  "hitl": {
    "version": "2.0.2",
    "id": "intver_01K0SV5HZAT9FSVVEB7S91SH4F"
  },
  "honeybook": {
    "version": "2.0.0",
    "id": "intver_01JFAQXRQ8TADY78EBPBKSXFPC"
  },
  "hubspot": {
    "version": "5.2.0",
    "id": "intver_01KA00D4PND97KRHJ2X9BDY2P7"
  },
  "hunter": {
    "version": "1.0.0",
    "id": "intver_01KA00DFT6W3K8DBR02GMAM99R"
  },
  "instagram": {
    "version": "4.1.6",
    "id": "intver_01KCVJSGRJYRNDX1QTE5TA2J0E"
  },
  "instantly": {
    "version": "2.0.0",
    "id": "intver_01JFAQXWNN3ZM0DAQBE7N2BP54"
  },
  "intercom": {
    "version": "2.0.2",
    "id": "intver_01KD3DHMS7HN4N4DAF7SBVWP5T"
  },
  "keap": {
    "version": "2.0.0",
    "id": "intver_01JFAQY1A6AQGSZRPKRJ11649R"
  },
  "kit": {
    "version": "2.0.0",
    "id": "intver_01JFAQYAZCH51RNSK7XT8ZKFZC"
  },
  "klaviyo": {
    "version": "3.0.2",
    "id": "intver_01K6BFXSKB0G4KMVGJPTR1X835"
  },
  "knack": {
    "version": "2.0.0",
    "id": "intver_01JFAQYKKW7JQJYH5GQW95AXFJ"
  },
  "kustomer": {
    "version": "2.0.0",
    "id": "intver_01JFAQYR6A4M0527JHDSNXN4TY"
  },
  "kylas": {
    "version": "2.0.0",
    "id": "intver_01JFAQYWG9PSP9076S99BE546R"
  },
  "leadsquared": {
    "version": "2.0.0",
    "id": "intver_01JFAQZ0PFZ7W5AJN0MZQJHGW7"
  },
  "leandata": {
    "version": "2.0.0",
    "id": "intver_01JFAQZ54J1MYP5D4WXZ1Z7KK7"
  },
  "less-annoying-crm": {
    "version": "2.0.0",
    "id": "intver_01JFAQZ99G8ZWD4847189A4EGS"
  },
  "line": {
    "version": "2.0.3",
    "id": "intver_01KBFTPABTXFTSGFPXVNSXWM31"
  },
  "linear": {
    "version": "1.2.0",
    "id": "intver_01KCSCJSD7TCP3P6QGX8QHADAP"
  },
  "localiq": {
    "version": "2.0.0",
    "id": "intver_01JFAQZDKZQV3J44CJF074YHXZ"
  },
  "loops": {
    "version": "0.1.2",
    "id": "intver_01K5C65MMSR9EF9ZCNTMVQA786"
  },
  "mailchimp": {
    "version": "0.3.8",
    "id": "intver_01KD3S9EJY0DZ4M0KEZP72BA5S"
  },
  "mailerlite": {
    "version": "3.0.2",
    "id": "intver_01K6BFZTMA8A1Z3KV1QXGWB61S"
  },
  "make": {
    "version": "0.3.6",
    "id": "intver_01KEYXNCV8ZWT6SKSZSJG8B8WG"
  },
  "messenger": {
    "version": "5.1.3",
    "id": "intver_01KESY33QD20ZF8B3PR2WTR971"
  },
  "mindtickle": {
    "version": "2.0.0",
    "id": "intver_01JFAQZNRAZMBAEZ943WY44EXD"
  },
  "mintlify": {
    "version": "1.0.0",
    "id": "intver_01K8TR6NDN8GCZ8TG133Z307YK"
  },
  "mistral-ai": {
    "version": "0.1.0",
    "id": "intver_01KEW1PHNVBBVS57TM74JKCBDH"
  },
  "monday": {
    "version": "1.0.0",
    "id": "intver_01JVYTJE7Q36MG5V3KCR8HVS01"
  },
  "mural": {
    "version": "2.0.0",
    "id": "intver_01JFAQZT1R0PR8C59Z1MHWMG83"
  },
  "notion": {
    "version": "3.0.0",
    "id": "intver_01KF15SA6NPZ1S1470WECYT5D0"
  },
  "nutshell": {
    "version": "2.0.0",
    "id": "intver_01JFAQZYAY7HCM2VTWTZK0GHZ6"
  },
  "okta": {
    "version": "2.0.0",
    "id": "intver_01JFAR02JMED7RK95YXCDRVNXX"
  },
  "openai": {
    "version": "18.0.0",
    "id": "intver_01KCHBZMZEM2017N9C0ND1STA5"
  },
  "outreach": {
    "version": "2.0.0",
    "id": "intver_01JFAR0717CX7YJNEX0FXRR8TN"
  },
  "pandadoc": {
    "version": "2.0.0",
    "id": "intver_01JFAR0BBGR1EGMRR2PRGHRABB"
  },
  "pdf-generator": {
    "version": "0.0.5",
    "id": "intver_01KEYXNX9CQDD2QZ8G41CX4XCA"
  },
  "pimcore": {
    "version": "2.0.0",
    "id": "intver_01JFAR0FRDMZNK1B1EYKTHKANP"
  },
  "pipedrive": {
    "version": "5.0.1",
    "id": "intver_01K6BG0EMJ1FQ0E5DCZZEN9301"
  },
  "pipeliner": {
    "version": "2.0.0",
    "id": "intver_01JFAR0R7XHB7VYX0Q0ETV9B3F"
  },
  "plaid": {
    "version": "2.0.0",
    "id": "intver_01JFAR0WH09T4MRTTQHRAH2ESD"
  },
  "planhat": {
    "version": "2.0.0",
    "id": "intver_01JFAR10SHDPEPXTJN6RRB9H6S"
  },
  "plus/apify": {
    "version": "1.0.3",
    "id": "intver_01K9DGKG0F7T1CZ5XMA07DB84N"
  },
  "plus/brevo-hitl": {
    "version": "2.0.0",
    "id": "intver_01K392AS04342HT6Z2HZZ60A2D"
  },
  "plus/chatwoot": {
    "version": "1.0.4",
    "id": "intver_01KD3BFCBTV2PNJ80V3VYFBC4M"
  },
  "plus/email-notifier": {
    "version": "1.1.1",
    "id": "intver_01KB0YDR2AQ5A8H0GBZ35J51MQ"
  },
  "plus/go-high-level": {
    "version": "1.0.4",
    "id": "intver_01K6BDMWTZ7FNKTGD4N8YDPH1H"
  },
  "plus/google-analytics": {
    "version": "0.2.4",
    "id": "intver_01HXS7S3FCANEG2EN5FKKWH722"
  },
  "plus/google-chat-spaces": {
    "version": "1.0.3",
    "id": "intver_01K6BDNG0ZNW5JXRA5RDQJQCWN"
  },
  "plus/google-sheets": {
    "version": "1.2.5",
    "id": "intver_01K6BDP63K6Y5HFVJ84R7EKP0Y"
  },
  "plus/hitl-api": {
    "version": "0.2.0",
    "id": "intver_01J804C5W78Y5FWHHNVWMR5VM3"
  },
  "plus/hubspot-help-desk-hitl": {
    "version": "3.1.1",
    "id": "intver_01KC2AWT9BDMTHV36AJRVEF4DN"
  },
  "plus/hubspot-hitl": {
    "version": "5.0.4",
    "id": "intver_01K6BF9Q6D3M6T3J3V541ZJC8Z"
  },
  "plus/huggingface": {
    "version": "0.0.1",
    "id": "intver_01J6FP62B7KEHH4NC4R7NBBTW5"
  },
  "plus/intercom-hitl": {
    "version": "2.0.5",
    "id": "intver_01KEWH6D0NF81Q1WB8W8V225A8"
  },
  "plus/jira": {
    "version": "0.2.4",
    "id": "intver_01KCVM0T96KA8YK723W3N8P494"
  },
  "plus/livechat-hitl": {
    "version": "3.0.2",
    "id": "intver_01K6BFYE44DVXKVFXBHKZED8P9"
  },
  "plus/magento2": {
    "version": "2.0.4",
    "id": "intver_01K6BKG43JX1R6ZEB4CXJ6R65D"
  },
  "plus/messaging": {
    "version": "0.2.3",
    "id": "intver_01HVM0R2R0QXWNH3BEZPYFK6ZJ"
  },
  "plus/mixpanel": {
    "version": "0.2.3",
    "id": "intver_01HXABTRSS5J9K0G1S1MPCX8J9"
  },
  "plus/persat": {
    "version": "1.0.0",
    "id": "intver_01K75D7C0JTQ5FY058T1187G32"
  },
  "plus/salesforce": {
    "version": "1.0.2",
    "id": "intver_01JRTXEF3N4CG8D668ANNW40DS"
  },
  "plus/segment": {
    "version": "0.2.4",
    "id": "intver_01HX7R8GHK3BKX2RHER1KYV0VT"
  },
  "plus/sharepoint": {
    "version": "4.1.0",
    "id": "intver_01K8XWKTBHY5AX8JTBV4T0D4V6"
  },
  "plus/sharepoint-excel": {
    "version": "2.2.1",
    "id": "intver_01K6BKHB4TQ5RFVA6W1VKAREFB"
  },
  "plus/shopify-products-sync": {
    "version": "3.0.2",
    "id": "intver_01K8VDHZ8FM3ZDMTYA8Y7EDXTT"
  },
  "plus/twiliovoice": {
    "version": "0.2.3",
    "id": "intver_01K6BKKDTZ1X8ECNS52N96M8AM"
  },
  "plus/zoho": {
    "version": "3.0.0",
    "id": "intver_01JNRREVZ0BA8VKEKMPMRF0DW5"
  },
  "plus/zohosalesiq": {
    "version": "2.0.0",
    "id": "intver_01JP37YJSERZGZQQW369F7W27C"
  },
  "plus/zoho-sales-iq-hitl": {
    "version": "3.0.0",
    "id": "intver_01K397TXPTA9982A829WV7XNX5"
  },
  "plus/zoom": {
    "version": "3.1.1",
    "id": "intver_01KAEBBGJ327TGZ0AZW31H6S19"
  },
  "posthog": {
    "version": "2.0.0",
    "id": "intver_01JFAR153DTQEGNZXMA4PAAV7D"
  },
  "postman": {
    "version": "2.0.0",
    "id": "intver_01JFAR19F7PZWCD9CBKAB30540"
  },
  "quickbooks": {
    "version": "2.0.0",
    "id": "intver_01JFAR1E05TRXX8ZHQ52QMG2KJ"
  },
  "reachdesk": {
    "version": "2.0.0",
    "id": "intver_01JFAR1JD70W5VTGDEDGFQXKEB"
  },
  "resend": {
    "version": "0.1.7",
    "id": "intver_01KD3DJC2CRQMY4CTR7B81697K"
  },
  "revenuehero": {
    "version": "2.0.0",
    "id": "intver_01JFAR1PDG5ZQHDAT4PX3J67N5"
  },
  "rippling": {
    "version": "0.0.4",
    "id": "intver_01JBMK2M3NWMH63ZTQBSQSEXHB"
  },
  "sage": {
    "version": "2.0.0",
    "id": "intver_01JFAR8RTCW2P6C8VWSMN7FQFS"
  },
  "salesflare": {
    "version": "2.0.0",
    "id": "intver_01JFAR2316BGX6S5NS812P3K1Z"
  },
  "salesloft": {
    "version": "2.0.0",
    "id": "intver_01JFAR27CFAGF2479ER2FSSDF7"
  },
  "sap": {
    "version": "2.0.0",
    "id": "intver_01JFAR2BP4TDJTAGWN841KBC1S"
  },
  "seismic": {
    "version": "2.0.0",
    "id": "intver_01JFAR2G7J0GAC6J69K8TN3429"
  },
  "sendgrid": {
    "version": "0.1.8",
    "id": "intver_01KD3DJKTCXG0JMKM0SZ1RWHHQ"
  },
  "showpad": {
    "version": "2.0.0",
    "id": "intver_01JFAR2MD45546TPY7V2CPBAMD"
  },
  "sisense": {
    "version": "2.0.0",
    "id": "intver_01JFAR2RSBXRYQ5YX9JNTP4A9C"
  },
  "slack": {
    "version": "3.1.3",
    "id": "intver_01KD3DJWPSBF4ACKZ9GNWXQG01"
  },
  "smartsheet": {
    "version": "2.0.0",
    "id": "intver_01JFAR2WXTE6FV2C2HP7V0WBTE"
  },
  "splunk": {
    "version": "0.0.4",
    "id": "intver_01JBMK2Y874WV5BGHXYN07HKHE"
  },
  "square": {
    "version": "2.0.0",
    "id": "intver_01JFARACGK6NT3YTKC5KVXVKX6"
  },
  "stripe": {
    "version": "0.5.4",
    "id": "intver_01KEYXP9M7BG0WC3ER5XVYQ1VB"
  },
  "sunco": {
    "version": "1.5.0",
    "id": "intver_01KEF51HC7QZHCETEMXGFH7BBR"
  },
  "surveymonkey": {
    "version": "2.0.0",
    "id": "intver_01JFAR3A2K8BEMP4XHQ7F5R47R"
  },
  "tableau": {
    "version": "2.0.0",
    "id": "intver_01JFAR3E9K4XXVYFE7SSGT1C9E"
  },
  "teamleader": {
    "version": "2.0.0",
    "id": "intver_01JFAR3JKE5HAGV6TBCW7SV4QM"
  },
  "teams": {
    "version": "2.0.1",
    "id": "intver_01KBNJVJYD8KGWR6A02KP96G2D"
  },
  "teamviewer": {
    "version": "2.0.0",
    "id": "intver_01JFAR3PY3EBMYYBKQTZAHESXP"
  },
  "telegram": {
    "version": "1.0.2",
    "id": "intver_01KAXVQFVSXRQGZR0ZJG883V4X"
  },
  "thryv": {
    "version": "2.0.0",
    "id": "intver_01JFAR3VQXXNJTR85472MM0RDY"
  },
  "todoist": {
    "version": "1.0.2",
    "id": "intver_01K899ZQCGQ0W948PKD1D2BQNM"
  },
  "trello": {
    "version": "1.2.0",
    "id": "intver_01KEF51YE9E2WY0PWVJQ8K2QX6"
  },
  "twilio": {
    "version": "1.0.4",
    "id": "intver_01KBFTS3NF4YR5SGN4CSW3AX1F"
  },
  "vcita": {
    "version": "2.0.0",
    "id": "intver_01JFAR3ZXVBWKYYJ53W7C4E4VB"
  },
  "vercel": {
    "version": "2.0.0",
    "id": "intver_01JFAR44YN7JA1Z86S8CACVG5C"
  },
  "viber": {
    "version": "1.0.3",
    "id": "intver_01KBFTSB6JXYZBM3TA3T5R8MZQ"
  },
  "vonage": {
    "version": "1.0.2",
    "id": "intver_01KBFTSKW1GRVHFAHHG2EPBWD5"
  },
  "webchat": {
    "version": "0.3.0",
    "id": "intver_01JBVV0VQW8XN3Z5V9K8DB1M3B"
  },
  "webflow": {
    "version": "3.1.1",
    "id": "intver_01K89A06XPFFX0E3EEG6E77GBG"
  },
  "webhook": {
    "version": "1.1.2",
    "id": "intver_01KAXVRCX3CAGAS63Z4FBBZRYS"
  },
  "whatsapp": {
    "version": "4.5.20",
    "id": "intver_01KCPW32DHHQS3BPJN0HA5MPB2"
  },
  "workable": {
    "version": "0.1.1",
    "id": "intver_01K97QZ0EXNRMJHM8HW5GBGWKW"
  },
  "workday": {
    "version": "2.0.0",
    "id": "intver_01JFARBCCKWG9BS7DT2RBW9D7B"
  },
  "wrike": {
    "version": "2.0.0",
    "id": "intver_01JFAR4H5WXG78YBE7MEG967MW"
  },
  "zapier": {
    "version": "0.3.6",
    "id": "intver_01KAXVRQQG68J08SWT7JRW90FM"
  },
  "zendesk": {
    "version": "3.0.4",
    "id": "intver_01KF15TFJKHTV1HJ5B9Y6H5D9K"
  },
  "zendesk-sell": {
    "version": "2.0.0",
    "id": "intver_01JFAR4NP3JGG1BPV4MFJ2HBC3"
  },
  "zoho": {
    "version": "3.1.2",
    "id": "intver_01KA92S3WKT4FYD0QW54M0QWSH"
  }
};

{/* vale on */}

<OpenInHub integration={integrationVersions.workable} />

The official Workable integration allows your bot to create and manage your Workable candidates.

## Setup

<Info>
  You will need:

  * A [published bot](/get-started/quick-start)
  * A [Workable account](https://id.workable.com/oidc/i/BtMboWMgw2NuejkYxadf_)
</Info>

<Steps>
  <Step title="Install the integration in Botpress">
    First, install the integration to your bot:

    1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
    2. Search for the **Workable** integration, then select **Install Integration**.
    3. Fill in the **Account subdomain** field with your company's subdomain (`https://mycompany.workable.com`)
    4. Leave the **API access token** field empty for now—you'll come back to them after getting your Workable API key.
  </Step>

  <Step title="Get your Workable API key">
    Next, get your Workable API key:

    1. [Log in to your Workable dashboard](https://id.workable.com/oidc/i/BtMboWMgw2NuejkYxadf_).
    2. Select your profile picture and go to **Settings**.
    3. In the left navigation bar, go to **Integrations > Apps**.
    4. Scroll to **API Access Tokens**, then select **Generate API token**.
    5. Add the `r_candidates` and `w_candidates` scopes.
    6. Copy the generated token.
  </Step>

  <Step title="Configure the integration in Botpress">
    Now, you can finish setting up the integration in Botpress:

    1. In the integration's **API access token** field, paste your Workable API key.
    2. Select **Save Configuration**.
  </Step>
</Steps>

<Check>
  Your integration is ready. You can use the integration's [Cards](#cards) and [Triggers](#triggers) to interact with your Workable candidates.
</Check>

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](/studio/concepts/cards/introduction) available with the integration:

### Create candidate in job

<span>
  {"Create a candidate in the specified job"}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="sourced" type="boolean">
      <span>
        {"Indicates if the candidate is sourced or applied"}
      </span>
    </ResponseField>

    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate to create"}
      </span>

      <Expandable>
        <ResponseField name="firstName" type="string" required>
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string" required>
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string" required>
          <span>
            {"The candidate's email address"}
          </span>
        </ResponseField>

        <ResponseField name="headline" type="string">
          <span>
            {"The candidate's headline"}
          </span>
        </ResponseField>

        <ResponseField name="summary" type="string">
          <span>
            {"The summary of the candidate"}
          </span>
        </ResponseField>

        <ResponseField name="address" type="string">
          <span>
            {"The candidate's address"}
          </span>
        </ResponseField>

        <ResponseField name="phone" type="string">
          <span>
            {"The candidate's phone number"}
          </span>
        </ResponseField>

        <ResponseField name="coverLetter" type="string">
          <span>
            {"The cover letter provided when the candidate applied"}
          </span>
        </ResponseField>

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="degree" type="string">
              <span>
                {"The graduation degree"}
              </span>
            </ResponseField>

            <ResponseField name="school" type="string" required>
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string">
              <span>
                {"The field of study"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="title" type="string" required>
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string">
              <span>
                {"The summary of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>

            <ResponseField name="company" type="string">
              <span>
                {"The company name"}
              </span>
            </ResponseField>

            <ResponseField name="current" type="boolean">
              <span>
                {"Indicates if currently works there"}
              </span>
            </ResponseField>

            <ResponseField name="industry" type="string">
              <span>
                {"The industry of the company"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string">
          <span>
            {"Reason for disqualification, if applicable"}
          </span>
        </ResponseField>

        <ResponseField name="disqualifiedAt" type="string">
          <span>
            {"The timestamp the candidate was disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="enum<string>" required>
              <span>
                {"The slug name of the social profile"}
              </span>

              Available options: `academiaedu`, `angellist`, `behance`, `bitbucket`, `blogger`, `crunchbase`, `dandyid`, `delicious`, `deviantart`, `digg`, `doyoubuzz`, `dribble`, `dribbble`, `econsultancy`, `facebook`, `flavorsme`, `flickr`, `fullcontact`, `getglue`, `gist`, `github`, `goodreads`, `googleplus`, `gravatar`, `hackernews`, `hiim`, `klout`, `lanyrd`, `linkedin`, `myspace`, `ohloh`, `orkut`, `pinterest`, `quora`, `reddit`, `scribd`, `slideshare`, `stackexchange`, `stackoverflow`, `tumblr`, `twitter`, `typepad`, `vk`, `wordpress`, `xing`
            </ResponseField>

            <ResponseField name="username" type="string">
              <span>
                {"The username of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="url" type="string" required>
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="domain" type="string">
          <span>
            {"Where the candidate came from"}
          </span>
        </ResponseField>

        <ResponseField name="recruiterKey" type="string">
          <span>
            {"The key corresponding to the recruiter who sourced the candidate"}
          </span>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string">
          <span>
            {"Url to the candidate resume"}
          </span>
        </ResponseField>

        <ResponseField name="resume" type="object">
          <Expandable>
            <ResponseField name="name" type="string" required>
              <span>
                {"The name of the file"}
              </span>
            </ResponseField>

            <ResponseField name="data" type="string" required>
              <span>
                {"The base64 encoded data"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="answers" type="array">
          <span>
            {"A collection with answers provided"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="questionKey" type="string" required>
              <span>
                {"The question key"}
              </span>
            </ResponseField>

            <ResponseField name="body" type="string">
              <span>
                {"The candidate's response"}
              </span>
            </ResponseField>

            <ResponseField name="checked" type="boolean">
              <span>
                {"The candidate's response"}
              </span>
            </ResponseField>

            <ResponseField name="choices" type="array">
              <span>
                {"The IDs of the choice(s) selected"}
              </span>
            </ResponseField>

            <ResponseField name="date" type="string">
              <span>
                {"The date in ISO 8601 format"}
              </span>
            </ResponseField>

            <ResponseField name="value" type="number">
              <span>
                {"The value may be an integer or a decimal number"}
              </span>
            </ResponseField>

            <ResponseField name="fileUrl" type="string">
              <span>
                {"A url pointing to the candidate's answer"}
              </span>
            </ResponseField>

            <ResponseField name="data" type="string">
              <span>
                {"The candidate's answer encoded in base64"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="shortCode" type="string" required>
      <span>
        {"The shortcode of the job the candidate is applying to"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="status" type="string" required>
      <span>
        {"The status of the candidate"}
      </span>
    </ResponseField>

    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate created"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="imageUrl" type="string | null" />

        <ResponseField name="disqualifiedAt" type="string | null" />

        <ResponseField name="outboundMailbox" type="string | null" />

        <ResponseField name="uploaderId" type="string | null" />

        <ResponseField name="coverLetter" type="string | null" />

        <ResponseField name="summary" type="string | null" />

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The education entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="degree" type="string | null" />

            <ResponseField name="school" type="string">
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The experience entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />

            <ResponseField name="company" type="string | null" />

            <ResponseField name="industry" type="string | null" />

            <ResponseField name="current" type="boolean | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="name" type="string" />
          </Expandable>
        </ResponseField>

        <ResponseField name="answers" type="array">
          <span>
            {"A collection with answers provided"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="question" type="object" required>
              <Expandable>
                <ResponseField name="body" type="string | null" required />
              </Expandable>
            </ResponseField>

            <ResponseField name="answer" type="string | null" required />
          </Expandable>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string | null" />

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="string">
              <span>
                {"The slug name of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="name" type="string | null" />

            <ResponseField name="username" type="string | null" />

            <ResponseField name="url" type="string">
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="location" type="object | null" />

        <ResponseField name="originatingCandidateId" type="string | null" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Create candidate in talent pool

<span>
  {"Create a candidate in the talent pool"}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="sourced" type="boolean">
      <span>
        {"Indicates if the candidate is sourced or applied"}
      </span>
    </ResponseField>

    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate to create"}
      </span>

      <Expandable>
        <ResponseField name="firstName" type="string" required>
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string" required>
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string" required>
          <span>
            {"The candidate's email address"}
          </span>
        </ResponseField>

        <ResponseField name="headline" type="string">
          <span>
            {"The candidate's headline"}
          </span>
        </ResponseField>

        <ResponseField name="summary" type="string">
          <span>
            {"The summary of the candidate"}
          </span>
        </ResponseField>

        <ResponseField name="address" type="string">
          <span>
            {"The candidate's address"}
          </span>
        </ResponseField>

        <ResponseField name="phone" type="string">
          <span>
            {"The candidate's phone number"}
          </span>
        </ResponseField>

        <ResponseField name="coverLetter" type="string">
          <span>
            {"The cover letter provided when the candidate applied"}
          </span>
        </ResponseField>

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="degree" type="string">
              <span>
                {"The graduation degree"}
              </span>
            </ResponseField>

            <ResponseField name="school" type="string" required>
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string">
              <span>
                {"The field of study"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="title" type="string" required>
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string">
              <span>
                {"The summary of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>

            <ResponseField name="company" type="string">
              <span>
                {"The company name"}
              </span>
            </ResponseField>

            <ResponseField name="current" type="boolean">
              <span>
                {"Indicates if currently works there"}
              </span>
            </ResponseField>

            <ResponseField name="industry" type="string">
              <span>
                {"The industry of the company"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string">
          <span>
            {"Reason for disqualification, if applicable"}
          </span>
        </ResponseField>

        <ResponseField name="disqualifiedAt" type="string">
          <span>
            {"The timestamp the candidate was disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="enum<string>" required>
              <span>
                {"The slug name of the social profile"}
              </span>

              Available options: `academiaedu`, `angellist`, `behance`, `bitbucket`, `blogger`, `crunchbase`, `dandyid`, `delicious`, `deviantart`, `digg`, `doyoubuzz`, `dribble`, `dribbble`, `econsultancy`, `facebook`, `flavorsme`, `flickr`, `fullcontact`, `getglue`, `gist`, `github`, `goodreads`, `googleplus`, `gravatar`, `hackernews`, `hiim`, `klout`, `lanyrd`, `linkedin`, `myspace`, `ohloh`, `orkut`, `pinterest`, `quora`, `reddit`, `scribd`, `slideshare`, `stackexchange`, `stackoverflow`, `tumblr`, `twitter`, `typepad`, `vk`, `wordpress`, `xing`
            </ResponseField>

            <ResponseField name="username" type="string">
              <span>
                {"The username of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="url" type="string" required>
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="domain" type="string">
          <span>
            {"Where the candidate came from"}
          </span>
        </ResponseField>

        <ResponseField name="recruiterKey" type="string">
          <span>
            {"The key corresponding to the recruiter who sourced the candidate"}
          </span>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string">
          <span>
            {"Url to the candidate resume"}
          </span>
        </ResponseField>

        <ResponseField name="resume" type="object">
          <Expandable>
            <ResponseField name="name" type="string" required>
              <span>
                {"The name of the file"}
              </span>
            </ResponseField>

            <ResponseField name="data" type="string" required>
              <span>
                {"The base64 encoded data"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="status" type="string" required>
      <span>
        {"The status of the candidate"}
      </span>
    </ResponseField>

    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate created"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="imageUrl" type="string | null" />

        <ResponseField name="disqualifiedAt" type="string | null" />

        <ResponseField name="outboundMailbox" type="string | null" />

        <ResponseField name="uploaderId" type="string | null" />

        <ResponseField name="coverLetter" type="string | null" />

        <ResponseField name="summary" type="string | null" />

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The education entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="degree" type="string | null" />

            <ResponseField name="school" type="string">
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The experience entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />

            <ResponseField name="company" type="string | null" />

            <ResponseField name="industry" type="string | null" />

            <ResponseField name="current" type="boolean | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="name" type="string" />
          </Expandable>
        </ResponseField>

        <ResponseField name="answers" type="array">
          <span>
            {"A collection with answers provided"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="question" type="object" required>
              <Expandable>
                <ResponseField name="body" type="string | null" required />
              </Expandable>
            </ResponseField>

            <ResponseField name="answer" type="string | null" required />
          </Expandable>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string | null" />

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="string">
              <span>
                {"The slug name of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="name" type="string | null" />

            <ResponseField name="username" type="string | null" />

            <ResponseField name="url" type="string">
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="location" type="object | null" />

        <ResponseField name="originatingCandidateId" type="string | null" />

        <ResponseField name="talentPool" type="object" required>
          <span>
            {"The talent pool fields"}
          </span>

          <Expandable>
            <ResponseField name="talentPoolId" type="number" required>
              <span>
                {"The ID of the candidate in the talent pool"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Get candidate

<span>
  {"Get a candidate by ID"}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="id" type="string" required>
      <span>
        {"The candidate's ID"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="candidate" type="object">
      <span>
        {"The candidate found"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="imageUrl" type="string | null" />

        <ResponseField name="disqualifiedAt" type="string | null" />

        <ResponseField name="outboundMailbox" type="string | null" />

        <ResponseField name="uploaderId" type="string | null" />

        <ResponseField name="coverLetter" type="string | null" />

        <ResponseField name="summary" type="string | null" />

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The education entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="degree" type="string | null" />

            <ResponseField name="school" type="string">
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The experience entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />

            <ResponseField name="company" type="string | null" />

            <ResponseField name="industry" type="string | null" />

            <ResponseField name="current" type="boolean | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="name" type="string" />
          </Expandable>
        </ResponseField>

        <ResponseField name="answers" type="array">
          <span>
            {"A collection with answers provided"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="question" type="object" required>
              <Expandable>
                <ResponseField name="body" type="string | null" required />
              </Expandable>
            </ResponseField>

            <ResponseField name="answer" type="string | null" required />
          </Expandable>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string | null" />

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="string">
              <span>
                {"The slug name of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="name" type="string | null" />

            <ResponseField name="username" type="string | null" />

            <ResponseField name="url" type="string">
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="location" type="object | null" />

        <ResponseField name="originatingCandidateId" type="string | null" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Get job questions

<span>
  {"Get the questions associated with a job offer"}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="shortCode" type="string" required>
      <span>
        {"The job's system generated code"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="questions" type="array" required>
      <span>
        {"The questions"}
      </span>

      <Expandable title="array item properties">
        <ResponseField name="id" type="string" required>
          <span>
            {"The question's id"}
          </span>
        </ResponseField>

        <ResponseField name="body" type="string" required>
          <span>
            {"The question's body"}
          </span>
        </ResponseField>

        <ResponseField name="type" type="enum<string>" required>
          <span>
            {"The question's type"}
          </span>

          Available options: `free_text`, `multiple_choice`, `boolean`, `dropdown`, `numeric`, `date`, `file`
        </ResponseField>

        <ResponseField name="required" type="boolean" required>
          <span>
            {"specifies wether providing an answer to the question is required"}
          </span>
        </ResponseField>

        <ResponseField name="singleAnswer" type="boolean">
          <span>
            {"Wether the question allows for multiple answers. Defined only for type multiple_choice."}
          </span>
        </ResponseField>

        <ResponseField name="choices" type="array">
          <span>
            {"An array specifying the possible answers. Defined only for types multiple_choice and dropdown."}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string" required>
              <span>
                {"The choice's id"}
              </span>
            </ResponseField>

            <ResponseField name="body" type="string" required>
              <span>
                {"The choice's text"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="supportedFileTypes" type="array">
          <span>
            {"An array specifying the accepted file types. Defined only if question type is file."}
          </span>
        </ResponseField>

        <ResponseField name="maxFileSize" type="number">
          <span>
            {"The maximum file size in bytes. Defined only if question is file"}
          </span>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### List candidates

<span>
  {"List the candidates for a job"}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="email" type="string">
      <span>
        {"The email of the candidate to filter by"}
      </span>
    </ResponseField>

    <ResponseField name="shortCode" type="string">
      <span>
        {"The job's system generated code"}
      </span>
    </ResponseField>

    <ResponseField name="stage" type="string">
      <span>
        {"The job's stage slug, can be retrieved from the '/stages' endpoint"}
      </span>
    </ResponseField>

    <ResponseField name="limit" type="number">
      <span>
        {"Specifies the number of candidates to try and retrieve per page"}
      </span>
    </ResponseField>

    <ResponseField name="nextToken" type="string">
      <span>
        {"Returns results with an ID greater than or equal to the specified ID"}
      </span>
    </ResponseField>

    <ResponseField name="createdAfter" type="string">
      <span>
        {"Returns results created after the specified timestamp"}
      </span>
    </ResponseField>

    <ResponseField name="updatedAfter" type="string">
      <span>
        {"Returns results updated after the specified timestamp"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="candidates" type="array" required>
      <span>
        {"The array of candidates"}
      </span>

      <Expandable title="array item properties">
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nextToken" type="string">
      <span>
        {"The token for the next page of results"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

### Update candidate

<span>
  {"Update an existing candidate. Omitted fields will remain unchanged."}
</span>

<ResponseField name="input" type="object">
  <Expandable>
    <ResponseField name="id" type="string" required>
      <span>
        {"The candidate to update's id"}
      </span>
    </ResponseField>

    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate to update"}
      </span>

      <Expandable>
        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string">
          <span>
            {"The candidate's email address"}
          </span>
        </ResponseField>

        <ResponseField name="headline" type="string">
          <span>
            {"The candidate's headline"}
          </span>
        </ResponseField>

        <ResponseField name="summary" type="string">
          <span>
            {"The summary of the candidate"}
          </span>
        </ResponseField>

        <ResponseField name="address" type="string">
          <span>
            {"The candidate's address"}
          </span>
        </ResponseField>

        <ResponseField name="phone" type="string">
          <span>
            {"The candidate's phone number"}
          </span>
        </ResponseField>

        <ResponseField name="coverLetter" type="string">
          <span>
            {"The cover letter provided when the candidate applied"}
          </span>
        </ResponseField>

        <ResponseField name="educationEntries" type="array">
          <span>
            {"Existing entries will be deleted if not included in the new array."}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The education entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="degree" type="string">
              <span>
                {"The graduation degree"}
              </span>
            </ResponseField>

            <ResponseField name="school" type="string" required>
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string">
              <span>
                {"The field of study"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"Existing entries will be deleted if not included in the new array."}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The experience entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string" required>
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string">
              <span>
                {"The summary of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="startDate" type="string">
              <span>
                {"The date started"}
              </span>
            </ResponseField>

            <ResponseField name="endDate" type="string">
              <span>
                {"The date ended"}
              </span>
            </ResponseField>

            <ResponseField name="company" type="string">
              <span>
                {"The company name"}
              </span>
            </ResponseField>

            <ResponseField name="industry" type="string">
              <span>
                {"The industry of the company"}
              </span>
            </ResponseField>

            <ResponseField name="current" type="boolean">
              <span>
                {"Indicates if currently works there"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"Existing profiles will be deleted if not included in the new array."}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="enum<string>" required>
              <span>
                {"The slug name of the social profile"}
              </span>

              Available options: `academiaedu`, `angellist`, `behance`, `bitbucket`, `blogger`, `crunchbase`, `dandyid`, `delicious`, `deviantart`, `digg`, `doyoubuzz`, `dribble`, `dribbble`, `econsultancy`, `facebook`, `flavorsme`, `flickr`, `fullcontact`, `getglue`, `gist`, `github`, `goodreads`, `googleplus`, `gravatar`, `hackernews`, `hiim`, `klout`, `lanyrd`, `linkedin`, `myspace`, `ohloh`, `orkut`, `pinterest`, `quora`, `reddit`, `scribd`, `slideshare`, `stackexchange`, `stackoverflow`, `tumblr`, `twitter`, `typepad`, `vk`, `wordpress`, `xing`
            </ResponseField>

            <ResponseField name="name" type="string">
              <span>
                {"The full name of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="username" type="string">
              <span>
                {"The username of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="url" type="string" required>
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string">
          <span>
            {"Url to the candidate resume"}
          </span>
        </ResponseField>

        <ResponseField name="resume" type="object">
          <Expandable>
            <ResponseField name="name" type="string" required>
              <span>
                {"The name of the file"}
              </span>
            </ResponseField>

            <ResponseField name="data" type="string" required>
              <span>
                {"The base64 encoded data"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="textingConsent" type="enum<string>">
          Available options: `forced`, `declined`
        </ResponseField>

        <ResponseField name="imageUrl" type="string">
          <span>
            {"A url pointing to the candidate's image"}
          </span>
        </ResponseField>

        <ResponseField name="imageSource" type="enum<string>">
          <span>
            {"The source of the image (if not provided by the candidate)"}
          </span>

          Available options: `academiaedu`, `angellist`, `behance`, `bitbucket`, `blogger`, `crunchbase`, `dandyid`, `delicious`, `deviantart`, `digg`, `doyoubuzz`, `dribble`, `dribbble`, `econsultancy`, `facebook`, `flavorsme`, `flickr`, `fullcontact`, `getglue`, `gist`, `github`, `goodreads`, `googleplus`, `gravatar`, `hackernews`, `hiim`, `klout`, `lanyrd`, `linkedin`, `myspace`, `ohloh`, `orkut`, `pinterest`, `quora`, `reddit`, `scribd`, `skype`, `slideshare`, `stackexchange`, `stackoverflow`, `tumblr`, `twitter`, `typepad`, `vk`, `wordpress`, `xing`
        </ResponseField>

        <ResponseField name="image" type="object">
          <Expandable>
            <ResponseField name="name" type="string">
              <span>
                {"The candidate's image name"}
              </span>
            </ResponseField>

            <ResponseField name="data" type="string">
              <span>
                {"The candidate's image encodede in base64"}
              </span>
            </ResponseField>

            <ResponseField name="source" type="enum<string>">
              <span>
                {"The image source"}
              </span>

              Available options: `academiaedu`, `angellist`, `behance`, `bitbucket`, `blogger`, `crunchbase`, `dandyid`, `delicious`, `deviantart`, `digg`, `doyoubuzz`, `dribble`, `dribbble`, `econsultancy`, `facebook`, `flavorsme`, `flickr`, `fullcontact`, `getglue`, `gist`, `github`, `goodreads`, `googleplus`, `gravatar`, `hackernews`, `hiim`, `klout`, `lanyrd`, `linkedin`, `myspace`, `ohloh`, `orkut`, `pinterest`, `quora`, `reddit`, `scribd`, `skype`, `slideshare`, `stackexchange`, `stackoverflow`, `tumblr`, `twitter`, `typepad`, `vk`, `wordpress`, `xing`
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="output" type="object">
  <Expandable>
    <ResponseField name="candidate" type="object" required>
      <span>
        {"The candidate updated"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="imageUrl" type="string | null" />

        <ResponseField name="disqualifiedAt" type="string | null" />

        <ResponseField name="outboundMailbox" type="string | null" />

        <ResponseField name="uploaderId" type="string | null" />

        <ResponseField name="coverLetter" type="string | null" />

        <ResponseField name="summary" type="string | null" />

        <ResponseField name="educationEntries" type="array">
          <span>
            {"A collection with education entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The education entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="degree" type="string | null" />

            <ResponseField name="school" type="string">
              <span>
                {"The name of the school graduated"}
              </span>
            </ResponseField>

            <ResponseField name="fieldOfStudy" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="experienceEntries" type="array">
          <span>
            {"A collection with experience entries"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="id" type="string">
              <span>
                {"The experience entry identifier"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The title of the experience entry"}
              </span>
            </ResponseField>

            <ResponseField name="summary" type="string | null" />

            <ResponseField name="startDate" type="string | null" />

            <ResponseField name="endDate" type="string | null" />

            <ResponseField name="company" type="string | null" />

            <ResponseField name="industry" type="string | null" />

            <ResponseField name="current" type="boolean | null" />
          </Expandable>
        </ResponseField>

        <ResponseField name="skills" type="array">
          <span>
            {"A collection of skills with names"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="name" type="string" />
          </Expandable>
        </ResponseField>

        <ResponseField name="answers" type="array">
          <span>
            {"A collection with answers provided"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="question" type="object" required>
              <Expandable>
                <ResponseField name="body" type="string | null" required />
              </Expandable>
            </ResponseField>

            <ResponseField name="answer" type="string | null" required />
          </Expandable>
        </ResponseField>

        <ResponseField name="resumeUrl" type="string | null" />

        <ResponseField name="socialProfiles" type="array">
          <span>
            {"A collection with social profiles of candidates"}
          </span>

          <Expandable title="array item properties">
            <ResponseField name="type" type="string">
              <span>
                {"The slug name of the social profile"}
              </span>
            </ResponseField>

            <ResponseField name="name" type="string | null" />

            <ResponseField name="username" type="string | null" />

            <ResponseField name="url" type="string">
              <span>
                {"Url to the candidate's social profile page"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tags" type="array">
          <span>
            {"A collection of tags"}
          </span>
        </ResponseField>

        <ResponseField name="location" type="object | null" />

        <ResponseField name="originatingCandidateId" type="string | null" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Triggers

{/* vale off */}

Here's a reference for all [Triggers](/studio/concepts/triggers/) available with the integration:

<Tip>
  You can access data returned from any of these Triggers by reading `event.payload` after the Trigger fires.
</Tip>

### Candidate Created

<span>
  {"A candidate was created on a job."}
</span>

<ResponseField name="payload" type="object">
  <span>
    {"Event data"}
  </span>

  <Expandable>
    <ResponseField name="firedAt" type="string" required>
      <span>
        {"The date and time the event was triggered"}
      </span>
    </ResponseField>

    <ResponseField name="id" type="string" required>
      <span>
        {"The event identifier"}
      </span>
    </ResponseField>

    <ResponseField name="resourceType" type="string" required>
      <span>
        {"The type of the payload resource"}
      </span>
    </ResponseField>

    <ResponseField name="data" type="object" required>
      <span>
        {"The candidate that was created"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="eventType" type="string" required>
      <span>
        {"The type of event"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>

### Candidate Moved

<span>
  {"A candidate was moved on a job."}
</span>

<ResponseField name="payload" type="object">
  <span>
    {"Event data"}
  </span>

  <Expandable>
    <ResponseField name="firedAt" type="string" required>
      <span>
        {"The date and time the event was triggered"}
      </span>
    </ResponseField>

    <ResponseField name="id" type="string" required>
      <span>
        {"The event identifier"}
      </span>
    </ResponseField>

    <ResponseField name="resourceType" type="string" required>
      <span>
        {"The type of the payload resource"}
      </span>
    </ResponseField>

    <ResponseField name="data" type="object" required>
      <span>
        {"The candidate that was moved"}
      </span>

      <Expandable>
        <ResponseField name="id" type="string">
          <span>
            {"The candidate identifier"}
          </span>
        </ResponseField>

        <ResponseField name="name" type="string">
          <span>
            {"The candidate's full name"}
          </span>
        </ResponseField>

        <ResponseField name="firstName" type="string">
          <span>
            {"The candidate's first name"}
          </span>
        </ResponseField>

        <ResponseField name="lastName" type="string">
          <span>
            {"The candidate's last name"}
          </span>
        </ResponseField>

        <ResponseField name="email" type="string | null" />

        <ResponseField name="headline" type="string | null" />

        <ResponseField name="account" type="object | null" />

        <ResponseField name="stage" type="string | null" />

        <ResponseField name="stageKind" type="string | null" />

        <ResponseField name="disqualified" type="boolean">
          <span>
            {"Flag indicating whether the candidate is disqualified"}
          </span>
        </ResponseField>

        <ResponseField name="withdrew" type="boolean">
          <span>
            {"Flag indicating whether the candidate withdrew"}
          </span>
        </ResponseField>

        <ResponseField name="disqualificationReason" type="string | null" />

        <ResponseField name="sourced" type="boolean">
          <span>
            {"Flag indicating whether the candidate has been sourced"}
          </span>
        </ResponseField>

        <ResponseField name="profileUrl" type="string | null" />

        <ResponseField name="domain" type="string | null" />

        <ResponseField name="createdAt" type="string">
          <span>
            {"The creation timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          <span>
            {"The last update timestamp of the candidate record"}
          </span>
        </ResponseField>

        <ResponseField name="hiredAt" type="string | null" />

        <ResponseField name="address" type="string | null" />

        <ResponseField name="phone" type="string | null" />

        <ResponseField name="job" type="object">
          <span>
            {"The job details"}
          </span>

          <Expandable>
            <ResponseField name="shortCode" type="string">
              <span>
                {"The job's system generated code"}
              </span>
            </ResponseField>

            <ResponseField name="title" type="string">
              <span>
                {"The job title"}
              </span>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="eventType" type="string" required>
      <span>
        {"The type of event"}
      </span>
    </ResponseField>
  </Expandable>
</ResponseField>