stratum.WebhooksApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
create_webhook	POST /api/v1/webhooks	Create webhook
delete_webhook	DELETE /api/v1/webhooks/{id}	Delete webhook
get_delivery_stats	GET /api/v1/webhooks/deliveries/stats	Get delivery statistics
get_webhook	GET /api/v1/webhooks/{id}	Get webhook
list_failed_deliveries	GET /api/v1/webhooks/deliveries/failed	List failed deliveries
list_webhook_deliveries	GET /api/v1/webhooks/{id}/deliveries	List webhook deliveries
list_webhooks	GET /api/v1/webhooks	List webhooks
retry_all_failed_deliveries	POST /api/v1/webhooks/deliveries/retry-all	Retry all failed deliveries
retry_delivery	POST /api/v1/webhooks/deliveries/{deliveryId}/retry	Retry single delivery
test_webhook	POST /api/v1/webhooks/{id}/test	Test webhook
update_webhook	PATCH /api/v1/webhooks/{id}	Update webhook

create_webhook

Webhook create_webhook(create_webhook_input)

Create webhook

Create a new webhook subscription.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.create_webhook_input import CreateWebhookInput
from stratum.models.webhook import Webhook
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    create_webhook_input = stratum.CreateWebhookInput() # CreateWebhookInput | 

    try:
        # Create webhook
        api_response = api_instance.create_webhook(create_webhook_input)
        print("The response of WebhooksApi->create_webhook:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->create_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_webhook_input	CreateWebhookInput

Return type

Webhook

Authorization

apiKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created webhook	-
400	Validation error	-

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

delete_webhook

delete_webhook(id)

Delete webhook

Delete a webhook subscription.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Delete webhook
        api_instance.delete_webhook(id)
    except Exception as e:
        print("Exception when calling WebhooksApi->delete_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID

Return type

void (empty response body)

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Webhook deleted	-
404	Webhook not found	-

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

get_delivery_stats

DeliveryStats get_delivery_stats()

Get delivery statistics

Get aggregate statistics for webhook deliveries.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.delivery_stats import DeliveryStats
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)

    try:
        # Get delivery statistics
        api_response = api_instance.get_delivery_stats()
        print("The response of WebhooksApi->get_delivery_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->get_delivery_stats: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DeliveryStats

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Delivery statistics	-

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

get_webhook

Webhook get_webhook(id)

Get webhook

Get a webhook by ID.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.webhook import Webhook
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Get webhook
        api_response = api_instance.get_webhook(id)
        print("The response of WebhooksApi->get_webhook:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->get_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID

Return type

Webhook

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Webhook details	-
404	Webhook not found	-

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

list_failed_deliveries

List[WebhookDelivery] list_failed_deliveries(limit=limit)

List failed deliveries

List failed webhook deliveries (dead-letter queue).

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.webhook_delivery import WebhookDelivery
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    limit = 100 # int | Maximum number of results (optional) (default to 100)

    try:
        # List failed deliveries
        api_response = api_instance.list_failed_deliveries(limit=limit)
        print("The response of WebhooksApi->list_failed_deliveries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->list_failed_deliveries: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Maximum number of results	[optional] [default to 100]

Return type

List[WebhookDelivery]

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of failed deliveries	-

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

list_webhook_deliveries

List[WebhookDelivery] list_webhook_deliveries(id)

List webhook deliveries

List delivery attempts for a specific webhook.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.webhook_delivery import WebhookDelivery
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # List webhook deliveries
        api_response = api_instance.list_webhook_deliveries(id)
        print("The response of WebhooksApi->list_webhook_deliveries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->list_webhook_deliveries: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID

Return type

List[WebhookDelivery]

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of deliveries	-
404	Webhook not found	-

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

list_webhooks

List[Webhook] list_webhooks(tenant_id=tenant_id)

List webhooks

List webhooks, optionally filtered by tenant.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.webhook import Webhook
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    tenant_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by tenant ID (optional)

    try:
        # List webhooks
        api_response = api_instance.list_webhooks(tenant_id=tenant_id)
        print("The response of WebhooksApi->list_webhooks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->list_webhooks: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_id	UUID	Filter by tenant ID	[optional]

Return type

List[Webhook]

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of webhooks	-

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

retry_all_failed_deliveries

RetryAllFailedDeliveries200Response retry_all_failed_deliveries()

Retry all failed deliveries

Retry all failed webhook deliveries in the dead-letter queue.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.retry_all_failed_deliveries200_response import RetryAllFailedDeliveries200Response
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)

    try:
        # Retry all failed deliveries
        api_response = api_instance.retry_all_failed_deliveries()
        print("The response of WebhooksApi->retry_all_failed_deliveries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->retry_all_failed_deliveries: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RetryAllFailedDeliveries200Response

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retry result	-

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

retry_delivery

SuccessResponse retry_delivery(delivery_id)

Retry single delivery

Retry a specific failed webhook delivery.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.success_response import SuccessResponse
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    delivery_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Retry single delivery
        api_response = api_instance.retry_delivery(delivery_id)
        print("The response of WebhooksApi->retry_delivery:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->retry_delivery: %s\n" % e)

Parameters

Name	Type	Description	Notes
delivery_id	UUID

Return type

SuccessResponse

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retry successful	-
404	Delivery not found or not in failed state	-

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

test_webhook

WebhookTestResult test_webhook(id)

Test webhook

Send a test event to a webhook endpoint.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.webhook_test_result import WebhookTestResult
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Test webhook
        api_response = api_instance.test_webhook(id)
        print("The response of WebhooksApi->test_webhook:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->test_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID

Return type

WebhookTestResult

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Test result	-
404	Webhook not found	-

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

update_webhook

Webhook update_webhook(id, update_webhook_input)

Update webhook

Update a webhook's URL, events, secret, or active status.

Example

Api Key Authentication (apiKey):
Bearer (JWT) Authentication (bearerAuth):

import stratum
from stratum.models.update_webhook_input import UpdateWebhookInput
from stratum.models.webhook import Webhook
from stratum.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = stratum.Configuration(
    host = "http://localhost:3000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.WebhooksApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    update_webhook_input = stratum.UpdateWebhookInput() # UpdateWebhookInput | 

    try:
        # Update webhook
        api_response = api_instance.update_webhook(id, update_webhook_input)
        print("The response of WebhooksApi->update_webhook:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->update_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID
update_webhook_input	UpdateWebhookInput

Return type

Webhook

Authorization

apiKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated webhook	-
404	Webhook not found	-

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

FilesExpand file tree

WebhooksApi.md

Latest commit

History

WebhooksApi.md

File metadata and controls

stratum.WebhooksApi

create_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_delivery_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_failed_deliveries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_webhook_deliveries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_webhooks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retry_all_failed_deliveries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retry_delivery

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_webhook

Example

Parameters