Basic information
What this step is for​
Describes what the application is, so that people can recognise it in the list of applications and know where to find more information. It does not contain any sign-in logic: that comes in the next steps.
On the right side of the page, the Preview shows how the application card (logo and name) will look in the list. It updates as you type.
Settings​
| Setting | Required | What to enter |
|---|---|---|
| Name | Yes | The name people see in the list of applications, for example Acme CRM. Up to 100 characters. |
| ShortName | Yes | A short identifier without spaces, up to 20 characters, for example ACMECRM. Canvas uses it to recognise the application, and workflow scripts use it as the first parameter of the api module methods, so choose it carefully and do not change it later. |
| Search tags | No | Words that help to find the application in lists and searches. Pick an existing tag from the list or type a new one and confirm it. You can add several. |
| Description | No | One or two sentences about what the application does. Up to 255 characters. |
| API documentation link | No | A link to the application's API documentation. It helps colleagues understand the settings in the next steps. |
| Vendor link | No | The website of the company that makes the application. |
| Logo | No | The picture shown on the application card. Use Upload File or drop a file onto the field. JPG, SVG or PNG, maximum 10 KB. |
Where ShortName is used​
In workflow and block scripts, the api module calls the application by its ShortName:
- in
api.get,api.postand the other URL based methods, the path starts with the ShortName; - in
api.send,api.authandapi.getAppVault, the ShortName is the first parameter.
If you rename the ShortName, every script that uses the old name stops working.
Tips​
- Use the name that customers know, not an internal code name.
- Write the description for someone who has never seen the application.
- Link directly to the API documentation page, not only the home page.
- Keep the logo simple and square. If the file is over 10 KB, reduce its size or use an SVG.
- Check the Preview to see how the card looks before you save.
Buttons​
| Button | What it does |
|---|---|
| Save & Continue | Saves the step and opens Step 2. Credentials Configuration. |
| Save & Exit | Saves and leaves the wizard. You can continue later. |
| Cancel | Leaves without saving the changes of the page. |
The buttons stay disabled until the required fields (Name and ShortName) are filled in.
Where to go next​
Continue with Step 2. Credentials Configuration.