Get Webhook Events

get https://app.mk.io/api/v1/projects/:project_name/webhook/rules/:rule_name/events

Get Events processed for the Webhook Rule.

RBAC Capability Required: webhooks.config.get

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

Response

200 A single Webhook Rule

• @odata.nextLink string Optional

@odata.nextLink URL if the page length and number of items match.

• supplemental object ListResponseSupplementalSchema Required

Supplemental info:

• count integer Required

Number of items returned

• kind string Required

Type of items in the list

• operation string Required

Operation type. Should always say 'list'

• pagination object PaginationInfoSchema Required

Pagination info: - end integer Required - records integer Required - start integer Required - total integer Required

• subscription object ProjectInfoSchema Optional

Project info:

• id string Required

• name string Required

• value list of objects WebhookEventBriefSchema Required

A list of Events for a Webhook rule:

• created string Required format: date-time

  Time the Event was created.

• source string Required

Path to the resource that triggered the Event.

• status enum Required

Event send status.

Allowed values: Pending, Retrying, Failed, Sent

• type enum Required

The type of the Event.

Allowed values: MediaKind.JobStarted, MediaKind.JobFinished, MediaKind.StreamingLocatorCreated, MediaKind.ChannelInstanceStarted, MediaKind.ChannelInstanceStopped, MediaKind.ChannelInstanceError, MediaKind.ScheduledOperationAccepted, MediaKind.ScheduledOperationCompleted, MediaKind.ScheduledOperationError, MediaKind.ScheduledOperationOngoing

Errors

• 400 Bad Request

• error object ErrorDetail Required

Pertinent information about the error: - code string Required - detail string Required - extraDetail map from strings to any Optional

  Extra information regarding this error.
- `ref` string Required
- `status` integer Required

• 401 Unauthorized

• error object ErrorDetail Required

Pertinent information about the error: - code string Required - detail string Required - extraDetail map from strings to any Optional - ref string Required - status integer Required

• 403 Forbidden

• error object ErrorDetail Required

• 404 Not Found

• error object ErrorDetail Required

• 429 Too Many Requests

• error object ErrorDetail Required

• 500 Internal Server Error

• error object ErrorDetail Required