웹훅

아웃코드가 제공하는 API Endpoint URL에 POST요청을 하여 데이터플로우를 실행시킵니다.

Endpoint URL

/:DOMAIN = 조직의 도메인 이름
/:NAME = 설계된 데이터플로우 이름
key: 보다 철저한 보안을 위해 API Key를 활용하여 API를 호출합니다. API Key는 마이페이지에서 확인하실 수 있습니다. 보다 자세한 사항은 관리자 페이지에서 확인하세요.

Fetch를 이용한 요청

API 요청을 받는 서버는 express로 구성되어 있습니다. fetch로 보낸 요청의 Body는 text로 변환되어 전송되는데, 이것을 서버가 정상적으로 인식하기 위해서는 headers를 아래와 같이 설정해 주어야 합니다.

(*. axios는 따로 필요한 설정이 없습니다.)

fetch('https://api.outcode.biz/:DOMAIN/:NAME?key=API_KEY', 
    {
        method: 'POST',
        headers: {
            'Accept': 'application/json, text/plain, */*',
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({ 'key1': 'value', 'key2': 0 })
    }
);

단순 트리거

아웃코드가 제공하는 API를 통해 설계된 데이터플로우를 구동시키는 역할만 합니다.

Request

아웃코드가 제공하는 API를 통해 데이터플로우에서 처리해야 할 데이터를 Request로 보냅니다. 특정 데이터를 포함하여 Request하고 싶을 경우 Body를 설정해야 합니다.

Request로 보낸 Body는 {{trigger.KEY}}으로 사용할 수 있습니다. Request Body 예제 { id: 'C25', title: 'workflow' }

Request Body 예제: { id: 'C25', title: 'workflow' } 
쿼리 활용 예제: SELECT * FROM YOUR_TABLE WHERE id = '{{trigger.id}}' AND title = '{{trigger.title}}'

Response

아웃코드가 제공하는 API를 통해 Response로 데이터플로우에서 실행된 마지막 노드의 결과값을 받고, 데이터플로우 설계에 활용할 수 있습니다.

실행된 변수값을 받아보기 위해서는 데이터를 정확히 명시해야 합니다.

응답 코드

200 데이터플로우 호출에 성공했습니다.

400 잘못된 요청입니다.

401 API Key 인증에 실패했습니다.

423 무료 서비스가 종료되었습니다.

500 서버에 문제가 생겨 요청을 수행하지 못했습니다.

예제

웹훅으로 아래 데이터가 body로 넘어오는 경우에는 구글시트로 저장하기

{name:"홍길동", email:"010-1111-1111"}

위의 웹훅데이터를 받아오려면 데이터플로우에 + 새입력추가를 누른 후 아래와 같이 key, value 필드에 body를 입력합니다.

그리고 구글시트에 {{trigger.body.name}}, {{trigger.body.email}}과 같은 형태로 입력합니다. 설정을 마치면 아래와 같습니다.

저장 후에 웹훅으로 보내면 구글시트에 name과 phone이 저장됩니다.

Last updated 1 year ago