웹 후크 (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"
  }
}