Create a webhook

post https://api.lokalise.com/api2/projects/{project_id}/webhooks

Creates a webhook in the project. Requires Manage settings admin right. See our documentation for available events and payload examples.

Requires write_webhooks OAuth access scope.

Path Params

project_id

string

required

A unique project identifier

Body Params

url

string

required

Specify the URL to your endpoint.

branch

string

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 null or skip this attribute, the webhook will be applied to all branches.

events

array of strings

required

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

events*

event_lang_map

array of objects

Map the event with an array of languages iso codes. Omit this parameter for all languages in the project. Currently only project.translation.updated and project.translation.proofread events can be mapped with languages.

event_lang_map

Response

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lokalise.com/api2/projects/project_id/webhooks \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK