Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Webhooks

Test a webhook

Perform a test request for a webhook. Sends a synthetic test:event payload to the webhook's callback_url and returns the webhook resource.

post/projects/{project_id}/webhooks/{id}/test

Path parameters

project_idstring required

Project ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

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"
}