Business Operations and ERPs
Copilot
14 min
true false 132false unhandled content type false unhandled content type requirements to use the copilot app in {{product name}} , you must have a paid copilot account with an admin access for subscription information, refer to the copilot pricing page connect copilot and {{product name}} to get started, you must first create a connection between copilot and {{product name}} , allowing the two services to communicate to create the connection, you need to copilot /#obtain your api key in copilot copilot /#create the connection in obtain your api key in copilot before you create the connection in {{product name}} , you should first obtain an api key in your copilot account to obtain the api key log in to your copilot account in the left sidebar, click settings > api in the rest api section, click create key enter a label for your key and click create key copy the api key value and store it in a safe place you'll use this value in the api key connection field in {{product name}} create the connection in {{product name}} once you have your copilot api key, you're ready to create the connection in {{product name}} to create the connection log in to your {{product name}} account, add a copilot module to your {{scenario singular lowercase}} , and click create a connection if you add a module with an instant tag, click create a webhook , then create a connection optional in the connection name field, enter a name for the connection in the api key field, enter the api key you copied from your copilot account click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the copilot app in your {{scenario plural lowercase}} if you want to make changes to your connection in the future, follow the steps here https //help make com/connect an application#tn2pj set up a copilot webhook the copilot app has instant modules — webhooks that watch for certain changes in copilot and immediately start your {{scenario singular lowercase}} when those changes happen to use these modules, you must set up the webhook in your copilot account to set up the webhook add a copilot instant module to your {{scenario singular lowercase}} and click create a webhook optional enter a name for the webhook in the webhook name field i n the connection field, select a connection for the webhook if you haven't created a copilot connection yet, refer to the copilot /#connect copilot and section above click save > copy address to clipboard you'll paste this address in your copilot account log in to your copilot account in the left sidebar, click settings > api in the webhooks section, click new webhook label your webhook for consistency, we recommend using the same name you used for the webhook in make paste the webhook url you copied in step 4 into the endpoint url field in the events to send field, choose the event that matches your copilot trigger module your webhook is now set up when the selected change occurs in copilot, {{product name}} will immediately be notified and start your {{scenario singular lowercase}} copilot modules after connecting to the copilot app, you can use the following types of modules to build your {{scenario plural lowercase}} clients watch created clients watch activated clients watch updated client custom fields watch updated clients watch deleted clients list clients create a client retrieve a client delete a client update a client retrieve custom field options companies watch created companies watch deleted companies watch updated companies list companies create a company retrieve a company update a company delete a company files list files watch created folders watch updated folders watch deleted folders watch created files watch updated files watch deleted files watch created links watch updated links watch deleted links list file channels create a file channel retrieve a file channel retrieve a file download a file retrieve a download url create a file create a folder create a link delete a file forms watch completed forms list forms list form responses retrieve a form request a form response contracts watch signed contracts watch requested contracts list contract templates retrieve a contract template list contracts retrieve a contract send a contract messages watch created message channels watch deleted message chanels watch sent messages list messages list message channels retrieve a message channel create a message channel send a message internal users list internal users retrieve an internal user watch created internal users watch deleted internal users workspaces retrieve workspace apps list app installs list app connections create an app connection billing watch paid invoices watch created invoices watch voided invoices watch deleted invoices watch sent invoices watch updated invoices watch created subscriptions watch canceled subscriptions watch successful payments watch failed payments watch created prices watch created products watch updated products list invoices list subscriptions list payments list invoice templates list subscription templates create an invoice create a subscription retrieve an invoice retrieve a subscription cancel a subscription list products retrieve a product list prices retrieve a price notes create a note retrieve a note list notes update a note delete a note watch created notes watch updated notes watch deleted notes tasks watch archived tasks watch completed tasks watch created tasks watch updated tasks watch deleted tasks list tasks create a task retrieve a task delete a task update a task list task templates retrieve a task template other make an api call copilot resources copilot api documentation copilot help center