Create or Update Webhook Rule

Management API · Webhook Rules

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

Create or Update Webhook Rule.

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

Authentication

• Authorization header — Bearer authentication of the form Bearer <token>.

Path parameters

Request body

Content type: application/json

• spec · object · Required — Webhook rule spec.
  • authentication · object · Optional — Authentication details.
    • headers · map from strings to string · Optional — Authentication headers.
      • [any key] · string — map of additional properties
    • queryParams · map from strings to string · Optional — Authentication query parameters.
      • [any key] · string — map of additional properties
  • enabled · boolean · Required — Indicates whether the webhook is enabled.
  • events · list of enums · Required — List of events that trigger the webhook.
    • Array items (enum):
  • headers · map from strings to string · Optional — Headers to include in the webhook request.
    • [any key] · string — map of additional properties
  • queryParams · map from strings to string · Optional — Query parameters to include in the webhook request.
    • [any key] · string — map of additional properties
  • url · string · Required — The URL the webhook should call.

Example request

curl -X PUT "https://app.mk.io/api/v1/projects/{project_name}/webhook/rules/{rule_name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "spec": {
    "authentication": {
      "headers": {
        "key": "string"
      },
      "queryParams": {
        "key": "string"
      }
    },
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "headers": {
      "key": "string"
    },
    "queryParams": {
      "key": "string"
    },
    "url": "string"
  }
}'

Responses

200 — Webhook Rule was updated

• metadata · object · Required — Webhook rule metadata.
  • id · string · Required · format: uuid — The ID of the webhook.
  • name · string · Required — The name of the webhook. Unique within a project.
• spec · object · Required — Webhook rule spec.
  • authentication · object · Optional — Authentication details.
    • headers · map from strings to string · Optional — Authentication headers.
      • [any key] · string — map of additional properties
    • queryParams · map from strings to string · Optional — Authentication query parameters.
      • [any key] · string — map of additional properties
  • enabled · boolean · Required — Indicates whether the webhook is enabled.
  • events · list of enums · Required — List of events that trigger the webhook.
    • Array items (enum):
  • headers · map from strings to string · Optional — Headers to include in the webhook request.
    • [any key] · string — map of additional properties
  • queryParams · map from strings to string · Optional — Query parameters to include in the webhook request.
    • [any key] · string — map of additional properties
  • url · string · Required — The URL the webhook should call.

Example:

{
  "metadata": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "spec": {
    "authentication": {
      "headers": {
        "key": "string"
      },
      "queryParams": {
        "key": "string"
      }
    },
    "enabled": true,
    "events": [
      "MediaKind.JobStarted"
    ],
    "headers": {
      "key": "string"
    },
    "queryParams": {
      "key": "string"
    },
    "url": "string"
  }
}

201 — Webhook Rule was created

Example:

400 — Bad Request

• error · object · Required — Pertinent information about the error
  • code · string · Required — The error code.
  • detail · string · Required — The error message.
  • extraDetail · map from strings to any · Optional — Extra information regarding this error.
    • [any key] · any — map of additional properties
• ref · string · Required — A reference to the request that caused the error.
• status · integer · Required — The HTTP status code

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}