Webhooks (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": "피터는 page.help.title을 프랑스어로 번역했습니다.",
  "sent_at": "2015-01-29T09:52:53Z"   
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "조 도우",
    "email": "joe@phrase.com",
    "position": "수석 개발자",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  },
  "project": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "내 안드로이드 프로젝트",
    "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": "내 번역"
    "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"
  }
}