​Configure Manifest Properties

Create the manifest for your app with the following properties. These properties are to be used (some are required) by all types of Weebly apps. There are additional entries needed for elements and dashboard cards.

  • manifest (required)

    The version of the Weebly Platform API your application was built to work with. The only currently supported value is 1.

  • client_id (required if using the RubyGem)

    The client_id of your application. The value is created when you register your app. This property is required if you plan on using the RubyGem to upload your app.

  • version (required)

    The version of your application. Provided as a string, following Semantic Versioning guidelines (Major.Minor.Patch: for example 1.5.13).

  • manage_app_url (optional)

    The manage url for the app. More details can be found here.

  • scopes (optional)

    Scopes needed to access information using the Weebly API. More details can be found here.

  • oauth_final_destination (optional)

    The destination you want the user to end at after the OAuth flow is complete. More details can be found here.

  • webhooks (optional)

    Describes the events and callback URL the app subscribes to using webhooks:

    • callback_url (required)

      The url for the webhook to call each time a supported event occurs

    • events (required)

      An array of event names to subscribe to. See Webhooks for a complete list.

  • snippet (optional)

    The relative path from the root to a file containing the snippet of html that will be included on every page of a published site. Useful for adding analytics to websites. This is a shortcut for calling the Snippet API.

​Your manifest requires additional entries if you are creating an element and dashboard cards.

Sample Manifest

This manifest shows the properties that all app types (backend services, snippets, elements) can have.


{
    "manifest": "1",
    "client_id": "123456D",
    "version": "1.0.0",
    "manage_app_url":   "https://my-site.com/manage-url",
    "scopes": ["read:site", "write:site"],
    "callback_url": "https://my-site.com/oauth-url",
    "oauth_final_destination": "editor",
    "webhooks": {
        "callback_url": "https://my-site.com/webhooks",
        "events": ["site.publish", "site.update"]
    },
    "snippet": "path/to/snippet.tpl"
. . .
}

Help make these docs better!