Webhook 구성

업데이트 됨

Webhook 구성 리소스는 API에서 Webhook 수신기에 이벤트를 보내는 데 사용됩니다.

조직은 자신의 webhook 구성을 지정하지 않은 해당 조직 내의 모든 키가 사용하는 기본 webook 구성을 가질 수 있습니다.

속성

이름 유형 기술
id webhook 구성 ID 자원 식별자.
resource 문자열, 항상 webhook_config 자원 유형 지정자.
organisation 조직 ID 리소스가 속한 조직입니다.
url 이벤트를 보낼 때 타겟팅 할 URL입니다.
secret 이벤트 서명을 확인하는 데 사용 된 공유 비밀.
state 다음 중 하나 : new , valid , invalid , deactivated .
date_created 날짜 시간 리소스가 생성 된 시점.

비밀

Webhook 구성이 생성되면 API와 함께 전송되는 이벤트에 서명하는 데 사용되는 비밀이 생성됩니다. 이 비밀을 사용하여 들어오는 이벤트의 서명을 확인하려면 웹 훅 수신기를 구현하는 것이 좋습니다. 서명 확인 절차에 대한 자세한 내용은 webhook 구성 설명서를 참조하십시오.

  • new 가 방금 생성되었거나 최근에 업데이트되었지만 아직 테스트되지 않았습니다.
  • valid 는 유효성 검사를 통과했으며 사용할 준비가되었습니다. 조직은이 상태에서 적어도 하나의 webhook 구성을 가져야 사용할 수 있습니다.
  • invalid 가 유효성 검사에 실패했습니다. 반드시 갱신되거나 재시험되어야합니다.
  • deactivated 된 것은 소유 조직에 의해 해제되었습니다.

POST /configs/webhook 만들기

이 작업은 끝점 정보를 확인하기 위해 webhook_config.test 작업을 만듭니다. Webhook 수신기가 아직 설정되지 않은 경우이 테스트는 실패하고 config를 invalid 상태로 설정합니다. 그러나 구성은 항상 테스트 동작을 사용하여 다시 테스트 할 수 있습니다.

매개 변수

이름 유형 기술
url 필수 webhook 수신기의 URL입니다.

cURL 사용

curl https://ricloud-api.reincubate.com/configs/webhook \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://www.mywebhook.com/webhooks/"
}'

ricloud-py 사용하기

import ricloud

webhook_config = ricloud.WebhookConfig.create(url='https://www.mywebhook.com/webhooks/')

GET /configs/webhook/{webhook_config ID}

cURL 사용

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \
  -H 'Authorization: Token <your key_token>'

ricloud-py 사용하기

import ricloud

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

GET /configs/webhook 목록보기

deactivated 상태의 Webhook 구성은 기본적으로 숨겨져 있으며 명시 적 필터링으로 만 나열 할 수 있습니다.

매개 변수

이름 유형 기술
state 웹 훅 설정을 상태별로 필터링합니다.
date_created 날짜 시간 필터 자원 생성 날짜별로 필터링하십시오.

업데이트 POST /configs/webhook/{webhook_config ID}

이 작업을 수행하면 백그라운드에서 webhook_confg.test 작업이 만들어져 구성에 대한 모든 변경 사항의 유효성이 검사됩니다.

본질적으로 구성을 폐기하는 경우에만 state 속성을 deactivated 로 변경할 수 있습니다.

매개 변수

이름 유형 기술
url URL을 업데이트하십시오.
state new 또는 deactivated 로만.

cURL 사용

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://www.myupdatedwebhook.com/webhooks/",
}'

ricloud-py 사용하기

import ricloud

webhook_config = ricloud.WebhookConfig.update_with_id(
  <webhook_config ID>,
  url='https://www.myupdatedwebhook.com/webhooks/'
)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

webhook_config.update(url='https://www.myupdatedwebhook.com/webhooks/')

POST /configs/webhook/{webhook_config ID}/test

이 작업은 지정된 구성을 사용하여 테스트 이벤트를 보내는 webhook_config.test 작업을 만듭니다. 테스트의 결과는 그에 따라 webook 구성의 state 속성을 업데이트합니다.

cURL 사용

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID>/test \
  -H 'Authorization: Token <your key_token>'

ricloud-py 사용하기

import ricloud

test_task = ricloud.WebhookConfig.test_with_id(<webhook_config ID>)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

test_task = webhook_config.test()

어떻게 도와 드릴까요?

지원 팀이 도와 드리겠습니다!

근무 시간은 월요일부터 금요일, 오전 9 시부 터 오후 5시 (그리니치 표준시)입니다. 시간은 현재 4:14 오후 GMT입니다.

우리는 1 일 이내에 모든 메시지에 답장하고자합니다.

지원 섹션으로 이동 › 엔터프라이즈 팀에 문의하십시오. ›
우리의 멋진 지원 팀

이 기사를 개선 할 수 있습니까?

사용자의 의견을 듣고 싶습니다. 전자 메일을 보내지 말고, 의견을 남기거나, 트윗하지 마십시오. @reincubate?

© 2008 - 2019 Reincubate Ltd. 판권 소유. 영국과 웨일즈에 등록 #5189175, VAT GB151788978. Reincubate®는 등록 상표입니다. 개인 정보 및 이용 약관. 우리는 2FA를 권장합니다. 런던에서 Built로 지어졌습니다.