Skip to content

WebhooksApi.md

Latest commit

 

History

History
403 lines (279 loc) · 14.1 KB

WebhooksApi.md

File metadata and controls

403 lines (279 loc) · 14.1 KB

mixpeek.WebhooksApi

All URIs are relative to https://api.mixpeek.com

Method HTTP request Description
create_webhook_organizations POST /v1/organizations/webhooks/ Create Webhook
delete_webhook_organizations DELETE /v1/organizations/webhooks/{identifier} Delete Webhook
get_webhook_organizations GET /v1/organizations/webhooks/{identifier} Get Webhook
list_webhooks_organizations POST /v1/organizations/webhooks/list List Webhooks
update_webhook_organizations PUT /v1/organizations/webhooks/{identifier} Update Webhook

create_webhook_organizations

WebhookOutput create_webhook_organizations(webhook_input, authorization=authorization)

Create Webhook

Create a new webhook for the user's organization.

Example

import mixpeek
from mixpeek.models.webhook_input import WebhookInput
from mixpeek.models.webhook_output import WebhookOutput
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.WebhooksApi(api_client)
    webhook_input = mixpeek.WebhookInput() # WebhookInput | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

    try:
        # Create Webhook
        api_response = api_instance.create_webhook_organizations(webhook_input, authorization=authorization)
        print("The response of WebhooksApi->create_webhook_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->create_webhook_organizations: %s\n" % e)

Parameters

Name Type Description Notes
webhook_input WebhookInput
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

Return type

WebhookOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
422 Validation Error -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_webhook_organizations

delete_webhook_organizations(identifier, authorization=authorization)

Delete Webhook

Delete a webhook (idempotent - succeeds even if already deleted).

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.WebhooksApi(api_client)
    identifier = 'identifier_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

    try:
        # Delete Webhook
        api_instance.delete_webhook_organizations(identifier, authorization=authorization)
    except Exception as e:
        print("Exception when calling WebhooksApi->delete_webhook_organizations: %s\n" % e)

Parameters

Name Type Description Notes
identifier str
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Successful Response -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
422 Validation Error -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhook_organizations

WebhookOutput get_webhook_organizations(identifier, authorization=authorization)

Get Webhook

Get a single webhook by its ID.

Example

import mixpeek
from mixpeek.models.webhook_output import WebhookOutput
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.WebhooksApi(api_client)
    identifier = 'identifier_example' # str | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

    try:
        # Get Webhook
        api_response = api_instance.get_webhook_organizations(identifier, authorization=authorization)
        print("The response of WebhooksApi->get_webhook_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->get_webhook_organizations: %s\n" % e)

Parameters

Name Type Description Notes
identifier str
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

Return type

WebhookOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
422 Validation Error -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_webhooks_organizations

ListWebhooksResponse list_webhooks_organizations(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, list_webhooks_request=list_webhooks_request)

List Webhooks

List all webhooks for the user's organization.

Example

import mixpeek
from mixpeek.models.list_webhooks_request import ListWebhooksRequest
from mixpeek.models.list_webhooks_response import ListWebhooksResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.WebhooksApi(api_client)
    limit = 56 # int |  (optional)
    offset = 56 # int |  (optional)
    cursor = 'cursor_example' # str |  (optional)
    include_total = False # bool |  (optional) (default to False)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    list_webhooks_request = mixpeek.ListWebhooksRequest() # ListWebhooksRequest |  (optional)

    try:
        # List Webhooks
        api_response = api_instance.list_webhooks_organizations(limit=limit, offset=offset, cursor=cursor, include_total=include_total, authorization=authorization, list_webhooks_request=list_webhooks_request)
        print("The response of WebhooksApi->list_webhooks_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->list_webhooks_organizations: %s\n" % e)

Parameters

Name Type Description Notes
limit int [optional]
offset int [optional]
cursor str [optional]
include_total bool [optional] [default to False]
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]
list_webhooks_request ListWebhooksRequest [optional]

Return type

ListWebhooksResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
422 Validation Error -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_webhook_organizations

WebhookOutput update_webhook_organizations(identifier, webhook_input, authorization=authorization)

Update Webhook

Update an existing webhook.

Example

import mixpeek
from mixpeek.models.webhook_input import WebhookInput
from mixpeek.models.webhook_output import WebhookOutput
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.WebhooksApi(api_client)
    identifier = 'identifier_example' # str | 
    webhook_input = mixpeek.WebhookInput() # WebhookInput | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

    try:
        # Update Webhook
        api_response = api_instance.update_webhook_organizations(identifier, webhook_input, authorization=authorization)
        print("The response of WebhooksApi->update_webhook_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->update_webhook_organizations: %s\n" % e)

Parameters

Name Type Description Notes
identifier str
webhook_input WebhookInput
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

Return type

WebhookOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
422 Validation Error -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]