Skip to content

Latest commit

 

History

History
356 lines (231 loc) · 15.1 KB

README.md

File metadata and controls

356 lines (231 loc) · 15.1 KB

Webhook

(webhook)

Overview

Operations related to webhook api

Available Operations

get_all

Retrieve a Webhook

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.get_all()

if res.data is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetWebhooksResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

create

To create a new webhook, you need to make an API call with the events you want to listen for and the URL that will be called when those events occur.

Example Usage

from livepeer import Livepeer
from livepeer.models import components

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.create(request={
    "name": "test_webhook",
    "url": "https://my-service.com/webhook",
    "project_id": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
    "events": [
        components.Events.STREAM_STARTED,
        components.Events.STREAM_IDLE,
    ],
    "shared_secret": "my-secret",
    "stream_id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
})

if res.webhook is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request components.WebhookInput ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateWebhookResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

get

Retrieve a webhook

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.get(id="<id>")

if res.webhook is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetWebhookResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

update

Update a webhook

Example Usage

from livepeer import Livepeer
from livepeer.models import components

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.update(id="<id>", webhook={
    "name": "test_webhook",
    "url": "https://my-service.com/webhook",
    "project_id": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
    "events": [
        components.Events.STREAM_STARTED,
        components.Events.STREAM_IDLE,
    ],
    "shared_secret": "my-secret",
    "stream_id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
})

if res.webhook is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
webhook components.WebhookInput ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateWebhookResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

delete

Delete a webhook

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.delete(id="<id>")

if res.webhook is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.DeleteWebhookResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

get_logs

Retrieve webhook logs

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.get_logs(id="<id>")

if res.data is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetWebhookLogsResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

get_log

Retrieve a webhook log

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.get_log(id="<id>", log_id="<value>")

if res.webhook_log is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
log_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetWebhookLogResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

resend_log

Use this API to resend the same webhook request. This is useful when developing and debugging, allowing you to easily repeat the same webhook to check or fix the behaviour in your handler.

Example Usage

from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.webhook.resend_log(id="<id>", log_id="<value>")

if res.webhook_log is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
id str ✔️ N/A
log_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ResendWebhookResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /