← back to Webhooks

Roles and Permissions

How to configure roles and permissions for use with webhooks.

Here, we discuss what roles and permissions are needed to manage webhooks. We also discuss how to create a role that can manage webhooks and assign that role to a member.

In order to see, configure, and use webhooks, members of your organization must have the right permission/role.

Note: In order to manage webhooks, your plan must enable them. A user with the proper permission/role will not be able to manage webhooks if the organization’s subscription does not enable them.

Permission

A member must have a role with the Change Organization Profile permission1 to manage webhooks.

Note: As the name implies, this permission gives the user the ability to do more than just manage webhooks. Since webhooks work at the organization level, it makes sense to have this permission tied to managing webhooks.

Roles

System Role

By default, the only role to have the above permission is the Owner System Role. This means the owner is initially the only person who can do anything with webhooks.

Custom Role

The organization’s owner (or any member with the Manage Roles permission) can create another role to have the Change Organization Profile permission. They can then give a member this role, and that member will be able to manage the webhooks.

Creating a Role for Webhooks

To create a role with the permissions to manage webhooks, follow these steps:

  1. Click the cog in the upper right of the page.
  2. Click Settings. If you were in another organization, on the left menu, click the organization you’re interested in.
  3. Click Roles in the list of links for that org’s settings.
  4. Click Add Role.
  5. Enter a Role Name (and optional Description).
  6. Check the Change Organization Profile permission.
  7. Click Save Role.

Screenshot with steps 1 & 2 for accessing information about roles. Screenshot with steps 3 & 4 to create a webhook role.

(steps 5-7 not shown in image)

This role is now available for use. Members with this role will have the ability to manage webhooks.

Note: These steps are for creating a new role, but you can also modify an existing, custom role to have this permission.

Assigning Webhooks Role to a Member

Once you’ve created a custom role with the Change Organization Profile permission, you can assign it to an existing member with the following steps:

  1. Click the cog in the upper right of the page.
  2. Click Settings. If you were in another organization, on the left menu, click the name of the organization you’re interested in.
  3. Click Members in the list of links for that org’s settings.
  4. Click Edit next to the applicable member’s name.
  5. Click the Role dropdown.
  6. Select the applicable role name.
  7. Click Save Member.

Screenshot with steps 1 & 2 for accessing information about members. Screenshot 1 of 2 for steps to assign a webhook role. Screenshot 2 of 2 of steps to assign a webhook role.

Now this member has a role with the permission needed to manage webhooks. They will see the Webhooks link in the organization’s settings links, be able to add and modify webhooks through the website, and access webhooks through the API.

Next Step

Now you can get started using webhooks!

Footnotes

  1. This permission is called can_update_organization in the API.

Still have questions? Browse our support forum and drop us a line.

Go to support