v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Webhooks

Create a webhook

Create a new webhook.

post/projects/{project_id}/webhooks

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

callback_urlstring required

Callback URL to send requests to

secretstring

Webhook secret used to calculate signature. If empty, the default project secret will be used.

descriptionstring

Webhook description

eventsstring

List of event names to trigger the webhook (separated by comma)

activeboolean

Whether webhook is active or inactive

include_branchesboolean

If enabled, webhook will also be triggered for events from branches of the project specified.

Example request

{
  "callback_url": "http://example.com/hooks/phraseapp-notifications",
  "secret": "secr3t",
  "description": "My webhook for chat notifications",
  "events": "locales:create,translations:update"
}

Response

Created

idstring

callback_urlstring

descriptionstring

eventsstring[]

activeboolean

include_branchesboolean

created_atstring date-time

updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "callback_url": "http://example.com/hooks/phraseapp-notifications",
  "description": "My webhook for chat notifications",
  "events": "locales:create,translations:update",
  "active": true,
  "include_branches": false,
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}