You can create two types of webhooks – resource-scoped or model element-scoped. Resource-scoped webhooks listen for resource-commit events. Webhooks that are element-scoped listen for model element commit events.

Tagged commit events, i.e., events when a resource is committed with specific commit tags, are only available for resource-scoped webhooks.

Creating resource-scoped webhooks

To create a resource-scoped webhook

  1. Go to the Settings application and select Webhooks on the left side of the screen.
  2. In the bottom right corner of the screen, click  to open the wizard for creating a webhook.
  3. In the first step of the wizard, type in the Webhook title and Webhook URL.
  4. Select Resource as the Webhook scope. With this webhook scope, you can also select Commit or Tagged commit event.
    For the option of Tagged commit, enter the commit tags to listen for:


  5. For the webhook to work, keep the option Enable turned on.
  6. You can also choose to Protect webhook URL with basic authentication. If you choose this option, enter the username and password:



  7. Click Next.
  8. In the second step of the wizard, select the Resource scope of the webhook. You can select either the Resource or Category option and search for a resource or a category in the search field:

     

  9. Once you select the resources or categories, click Create to create your webhook.

Creating model element-scoped webhooks

To create a model element-scoped webhook

  1. Go to the Settings application and select Webhooks on the left side of the screen.
  2. In the bottom right corner of the screen, click  to open the wizard for creating a webhook.
  3. In the first step of the wizard, type in the Webhook title and Webhook URL.
  4. Select Model element as the Webhook scope.
    Note that Tagged commit is not available for this option:



  5. 721pxFor the webhook to work, keep the option Enable turned on.
  6. You can also choose to Protect webhook URL with basic authentication. If you choose this option, enter the username and password:



  7. Click Next.
  8. In the second step of the wizard, select the Resource scope of the webhook. You can select either the Resource or Category option and search for a resource or a category in the search field:


  9. Click Next.
  10. In the next step select the Element scope.
    You can also check the Select recursively box if you want to include the element and its child elements into the webhook scope. If Select recursively is left unchecked, only the selected element will be included in the webhook scope:



  11. After making your selections, click Create to finish creating your new webhook.