Create a webhook

Creates a webhook in the project. Requires Manage settings admin right. See our <a href="https://docs.lokalise.com/en/articles/3184756-webhooks" target="_blank" rel="noopener noreferrer">documentation</a> for available events and payload examples.

Requires <code>write_webhooks</code> OAuth access scope.

post/projects/{project_id}/webhooks

Request

Base URL
https://api.lokalise.com/api2
URL
https://api.lokalise.com/api2/projects/{project_id}/webhooks
Auth
API key in header X-Api-Token

Path parameters

project_idstring required

A unique project identifier

Request body

urlstring required

Specify the URL to your endpoint.

branchstring

You can limit the usage of the webhook to a specific branch by specifying the name of the branch as a string. If you pass <code>null</code> or skip this attribute, the webhook will be applied to all branches.

eventsstring[] required

List of events to subscribe to. Possible values are <code>project.imported</code>, <code>project.exported</code>, <code>project.deleted</code>, <code>project.snapshot</code>, <code>project.languages.added</code>, <code>project.language.removed </code>, <code>project.language.settings_changed</code>, <code>project.key.added</code>, <code>project.key.modified</code>, <code>project.keys.deleted</code>, <code>project.key.comment.added</code>, <code>project.translation.updated</code>, <code>project.translation.proofread</code>, <code>project.contributor.added</code>, <code>project.contributor.deleted</code>, <code>project.task.created</code>, <code>project.task.closed</code>, <code>project.task.deleted</code>, <code>project.task.language.closed</code>, <code>project.branch.added</code>, <code>project.branch.deleted</code>, <code>project.branch.merged</code>, <code>team.order.created</code>, <code>team.order.completed</code>, <code>team.order.deleted</code>.

Response

project_idstring

Changes

No recorded changes to this operation across all 2 revisions of this API.