> This page is for mk.io.

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

# Create or Update Webhook Rule

PUT https://app.mk.io/api/v1/projects/{project_name}/webhook/rules/{rule_name}
Content-Type: application/json

Create or Update Webhook Rule.

RBAC Capability Required: `webhooks.config.create` or `webhooks.config.update`

Reference: https://mediakind.ferndocs.com/mkio/api/management/webhook-rules/create-or-update-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)

### Body (application/json)

This endpoint expects a WebhookRuleCreateOrUpdateSchema.

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

## Response

### 200

Webhook Rule was updated

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

### 201

Webhook Rule was created

- `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

### 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.

### WebhookRuleMetadataSchema

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

### 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

### Example 1

**Request**

```json
{
  "spec": {
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "url": "string"
  }
}
```

**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"

payload = { "spec": {
        "enabled": True,
        "events": ["MediaKind.JobStarted"],
        "url": "string"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"spec":{"enabled":true,"events":["MediaKind.JobStarted"],"url":"string"}}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}"

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.put("https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name', [
  'body' => '{
  "spec": {
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "url": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["spec": [
    "enabled": true,
    "events": ["MediaKind.JobStarted"],
    "url": "string"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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 = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Example 2

**Request**

```json
{
  "spec": {
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "url": "string"
  }
}
```

**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"

payload = { "spec": {
        "enabled": True,
        "events": ["MediaKind.JobStarted"],
        "url": "string"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"spec":{"enabled":true,"events":["MediaKind.JobStarted"],"url":"string"}}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}"

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.put("https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.mk.io/api/v1/projects/project_name/webhook/rules/rule_name', [
  'body' => '{
  "spec": {
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "url": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"spec\": {\n    \"enabled\": true,\n    \"events\": [\n      \"MediaKind.JobStarted\"\n    ],\n    \"url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["spec": [
    "enabled": true,
    "events": ["MediaKind.JobStarted"],
    "url": "string"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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 = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```