webtask-description-file.md

Webtask.json spec

webtask.json is a metadata file which contains the description of your extension.

{
  "title": "My Webtask",
  "name": "my-webtask",
  "version": "1.0.0",
  "author": "john.doe@auth0.com",
  "description": "My webtask helps you to ...",
  "type": "cron",
  "logoUrl": "{LINK_TO_YOUR_LOGO}",
  "codeUrl": "{LINK_TO_YOUR_WT_URL}",
  "keywords": [
    "auth0",
    "extension"
  ],
  "schedule": "0 */5 * * * *",
  "secrets": {
    "MY_SECRET": {
      "description": "My Secret",
      "required": true,
      "default": "hello world"
    }
  }
}

Field	Type	Required	Description	Example
title	String	true	A descriptive title for your extension.	Custom Social Connections.
name	String	true	It's the name of extension. Spaces are not allowed.	custom-social-connections
version	String	true	The version of your extension.	1.0.0
author	String	true	The author of the extension.	John Doe
description	true	String	A couple of lines describing what is the goal of your extension.	-
type	String	true	Indicates if your extension is application or a cron.	application
secrets	Object	false	Represents the secrets params that your extensions require to run correctly.	-
keywords	Array	false	Indicates the list of keywords that represents your extension.	auth0, extension, logs
logoUrl	String	false	A link to the logo for your extension	-
codeUrl	String	false	A link to the code of your extension	-
schedule	String	true (if type is cron)	The schedule for your cron	0 */10 * * * *
repository	String	false	A link to the repository of your extension	-

Secrets example

"secrets": {
  "S3_BUCKET":     {
    "description": "S3 Bucket name",
    "default": "my-bucket"
  }
}

Field	Type	Description
description	String	A couple of lines describing a secret.
readOnly	Boolean	Indicates if the secret is readonly or not.
type	String	Indicates the type of input, password or text or select.
example	String	An example to be used as placeholder.
required	Boolean	Indicates if the secret is required or not.
default	Any	Indicates the default value for the secret.
options	Array	An array of options for type select.
allowMultiple	Boolean	Indicates select allows multiple selection.