> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/mkio/api/management/webhook-rules/get-webhook-rule/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Get Webhook Rule

GET https://app.mk.io/api/v1/projects/{project_name}/webhook/rules/{rule_name}

Gets webhook rule by name.

RBAC Capability Required: `webhooks.config.get`

Reference: https://mediakind.ferndocs.com/mkio/api/management/webhook-rules/get-webhook-rule

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `project_name` (string, required)
- `rule_name` (string, required)

## Response

### 200

A single Webhook Rule

- `metadata` (WebhookRuleMetadataSchema, required) — Webhook rule metadata.
- `spec` (WebhookRuleSpecSchema, required) — Webhook rule spec.

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 403 Forbidden Error

Forbidden

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 404 Not Found Error

Not Found

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 429 Too Many Requests Error

Too Many Requests

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 500 Internal Server Error

Internal Server Error

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

## Types

### WebhookRuleMetadataSchema

- `id` (string, required) — The ID of the webhook.
- `name` (string, required) — The name of the webhook. Unique within a project.

### WebhookRuleSpecSchema

- `enabled` (boolean, required) — Indicates whether the webhook is enabled.
- `events` (list of enum, required) — List of events that trigger the webhook.
  - Allowed values: `MediaKind.JobStarted`, `MediaKind.JobFinished`, `MediaKind.StreamingLocatorCreated`, `MediaKind.ChannelInstanceStarted`, `MediaKind.ChannelInstanceStopped`, `MediaKind.ChannelInstanceError`, `MediaKind.ScheduledOperationAccepted`, `MediaKind.ScheduledOperationCompleted`, `MediaKind.ScheduledOperationError`, `MediaKind.ScheduledOperationOngoing`
- `url` (string, required) — The URL the webhook should call.
- `authentication` (AuthenticationSchema, optional) — Authentication details.
- `headers` (map from string to string, optional) — Headers to include in the webhook request.
- `queryParams` (map from string to string, optional) — Query parameters to include in the webhook request.

### ErrorDetail

- `code` (string, required) — The error code.
- `detail` (string, required) — The error message.
- `extraDetail` (map from string to any, optional) — Extra information regarding this error.

### AuthenticationSchema

- `headers` (map from string to string, optional) — Authentication headers.
- `queryParams` (map from string to string, optional) — Authentication query parameters.

## Examples

**Response**

```json
{
  "metadata": {
    "id": "string",
    "name": "string"
  },
  "spec": {
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "url": "string",
    "authentication": {
      "headers": {},
      "queryParams": {}
    },
    "headers": {},
    "queryParams": {}
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```