ウェブフック（文字列）

各ウェブフックペイロードの構造は、https://app.phrase.com/webhook_schemas/<event_underscored_name>.jsonにあるスキーマファイルで定義されています。ここで、<event_underscored_name>はアンダースコアを含むウェブフックイベントの名前に対応します。

ウェブフックを追加するには、次の手順に従ってください：

ウェブフックは、特定のウェブフックのその他メニューから無効にできます。

ウェブフックをテストするには：

RequestBinのようなサービスを使用して、ウェブフックの内容をキャプチャします。RequestBinは、リクエストデータを検査するために収集するURLを提供します。

指定されたタイプのイベントが発生するたびに、指定されたコールバックURLにPOSTリクエストが送信されます。リクエストのPOSTペイロードは、イベントに関連するデータを含むJSONエンコードされたドキュメントです。属性event、message、およびsent_atは常に含まれ、ウェブフックがトリガーされたユーザー、プロジェクト、およびブランチなどのイベントに関連する追加の属性が含まれます。

レスポンスヘッダー

コールバックURLに対して行われるHTTPリクエストには、いくつかの特別なヘッダーが含まれます。

例：

Content-Type: application/json
X-PhraseApp-Event: translation:create
X-PhraseApp-Signature: abc123

{
  "event": "translations:create",
  "message": "Peter translated page.help.title in fr.",
  "sent_at": "2015-01-29T09:52:53Z"   
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe",
    "email": "joe@phrase.com",
    "position": "Lead Developer",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  },
  "project": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "My Android Project",
    "main_format": "xml",
    "project_image_url": "http://assets.phrase.com/project.png",
    "account": "account",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  },
  "branch": {
  "name": "branch_name"
  },
  "translation": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "content": "My translation",
    "unverified": false,
    "excluded": false,
    "plural_suffix": "",
    "key": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "home.index.headline",
      "plural": false
    },
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE"
    },
    "placeholders": [
      "%{count}"
    ],
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  }
}