---
title: "Autify Webhook作成ガイド | Autify Guide"
slug: "creating-webhooks"
description: "AutifyでWebhookを作成する方法を学びましょう。シームレスな自動化テストを開始しましょう！"
updated: 2022-03-31T00:31:42Z
published: 2022-03-31T00:31:42Z
canonical: "help.autify.com/creating-webhooks"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.autify.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhookを作成する

## Webhookとは

Webhookを設定することで、特定のイベントが完了したときにその内容を受け取ることができます。そして受け取った内容を元にテスト結果の通知内容をカスタマイズしたり他のサービスと連携することが可能です。Webhookを簡単に試すための[レポジトリ](https://github.com/autifyhq/autify-demo-outgoing-webhook/)を用意したのでぜひお試しください。

## Webhookの設定

Webhookは以下の方法で設定します。

1. ワークスペース設定ページに遷移
2. Webhookセクションで**追加ボタン**を押下
3. Webhook URLとWebhookシークレット（任意）を設定

## Webhook URL

Autifyはイベント発生後に指定されたWebhook URLに`POST`リクエストを送ります。またその際のContent-Typeは`application/json`です。

## Webhookシークレット

Webhookシークレットを設定することで、Webhook URLに送られるリクエストがAutifyからのものであることを確認できます。また、シークレットを設定すると、Autifyからのリクエストヘッダに`X-Autify-Signature`が含まれます。詳細は"[Webhookをより安全に利用する](/v1/docs/ja/securing-your-webhooks)"を参照してください。

## Webhookで受け取れるイベント

### テストプラン結果

テストプランの終了時にイベントを送ります。

**Webhookペイロードの例**

```
{
    "action":"finished",
    "id":1,
    "test_plan": {
        "id": 2,
        "name": "New Test Plan"
    },
    "started_at":"2020-07-14T06:37:39.598Z",
    "finished_at":"2020-07-14T06:37:59.456Z",
    "status":"passed",
    "review_needed": false,
    "url":"https://app.autify.com/projects/1/results/1",
    "scenarios":[{
        "action":"finished",
        "id":1,
        "started_at":"2020-07-14T06:37:39.598Z",
        "finished_at":"2020-07-14T06:37:59.456Z",
        "status":"passed",
        "url":"https://app.autify.com/projects/1/results/1/capabilities/1/scenarios/1",
        "scenario_id":1,
        "scenario_name":"New Scenario",
        "review_needed":false,
        "test_plan_id":1,
        "capability":{
            "os":"Linux",
            "os_version":null,
            "browser":"Chrome",
            "browser_version":"83.0",
            "device":null,
            "resolution":"1280x1024"
        }
    }]
}
```

### テストケース結果

テストケースの終了時にイベントを送ります。

**Webhookペイロードの例**

```
{
    "action":"finished",
    "id":1,
    "started_at":"2020-07-14T06:37:39.598Z",
    "finished_at":"2020-07-14T06:37:59.456Z",
    "status":"passed",
    "url":"https://app.autify.com/projects/1/results/1/capabilities/1/scenarios/1",
    "scenario_id":1,
    "scenario_name":"New Scenario",
    "review_needed":false,
    "test_plan_id":1,
    "capability":{
        "os":"Linux",
        "os_version":null,
        "browser":"Chrome",
        "browser_version":"83.0",
        "device":null,
        "resolution":"1280x1024"
    }
}
```