ウェブフック (Strings)

各ウェブフックペイロードの構造は、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"
  }
}