Skip to content

WebhooksApi.md

Latest commit

 

History

History
309 lines (196 loc) · 8.15 KB

WebhooksApi.md

File metadata and controls

309 lines (196 loc) · 8.15 KB

postiz_python_client.WebhooksApi

All URIs are relative to http://localhost

Method HTTP request Description
webhook_controller_create_a_webhook POST /webhooks
webhook_controller_delete_webhook DELETE /webhooks/{id}
webhook_controller_get_statistics GET /webhooks
webhook_controller_send_webhook POST /webhooks/send
webhook_controller_update_webhook PUT /webhooks

webhook_controller_create_a_webhook

webhook_controller_create_a_webhook(body)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

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


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

    try:
        api_instance.webhook_controller_create_a_webhook(body)
    except Exception as e:
        print("Exception when calling WebhooksApi->webhook_controller_create_a_webhook: %s\n" % e)

Parameters

Name Type Description Notes
body object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 -

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

webhook_controller_delete_webhook

webhook_controller_delete_webhook(id)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.WebhooksApi(api_client)
    id = 'id_example' # str | 

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

Parameters

Name Type Description Notes
id str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 -

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

webhook_controller_get_statistics

webhook_controller_get_statistics()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

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


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

    try:
        api_instance.webhook_controller_get_statistics()
    except Exception as e:
        print("Exception when calling WebhooksApi->webhook_controller_get_statistics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 -

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

webhook_controller_send_webhook

webhook_controller_send_webhook(url)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.WebhooksApi(api_client)
    url = 'url_example' # str | 

    try:
        api_instance.webhook_controller_send_webhook(url)
    except Exception as e:
        print("Exception when calling WebhooksApi->webhook_controller_send_webhook: %s\n" % e)

Parameters

Name Type Description Notes
url str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 -

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

webhook_controller_update_webhook

webhook_controller_update_webhook(body)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

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


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

    try:
        api_instance.webhook_controller_update_webhook(body)
    except Exception as e:
        print("Exception when calling WebhooksApi->webhook_controller_update_webhook: %s\n" % e)

Parameters

Name Type Description Notes
body object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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