swagger_client.WebhooksApi

All URIs are relative to https://localhost/api/v1

Method	HTTP request	Description
add_hook_for_org	POST /orgs/{orgid}/hooks	Add hook for organization
add_hook_for_project	POST /orgs/{orgid}/projects/{projectid}/hooks	Add hook for project
delete_hook	DELETE /orgs/{orgid}/hooks/{id}	Delete organization hook
delete_hook_0	DELETE /orgs/{orgid}/projects/{projectid}/hooks/{id}	Delete project hook
get_hook	GET /orgs/{orgid}/hooks/{id}	Get organization hook details
get_hook_0	GET /orgs/{orgid}/projects/{projectid}/hooks/{id}	Get project hook details
list_hooks_for_org	GET /orgs/{orgid}/hooks	List hooks for organization
list_hooks_for_project	GET /orgs/{orgid}/projects/{projectid}/hooks	List hooks for project
ping_hook	POST /orgs/{orgid}/hooks/{id}/ping	Ping an org hook
ping_hook_0	POST /orgs/{orgid}/projects/{projectid}/hooks/{id}/ping	Ping a project hook
update_hook	PUT /orgs/{orgid}/hooks/{id}	Update hook for organization
update_hook_0	PUT /orgs/{orgid}/projects/{projectid}/hooks/{id}	Update hook for project

add_hook_for_org

InlineResponse2007 add_hook_for_org(orgid, options=options)

Add hook for organization

Adds a new organization level hook. An organization level hook is triggered by events from all projects belonging to the organziation. NOTE: you must be a manager in the organization to add new hooks.

Hook Type Configuration Parameters

Type Configuration Options

web

url	Endpoint to submit POST request
encoding	Either `json` (default) or `form`
sslVerify	Verify SSL certificates of HTTPS endpoint
secret	Used to compute the SHA256 HMAC signature of the hook body and adds a `X-UnityCloudBuild-Signature` header to the payload

slack

url	Slack incoming webhook URL. Learn more at https://api.slack.com/incoming-webhooks

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
options = swagger_client.Options2() # Options2 |  (optional)

try: 
    # Add hook for organization
    api_response = api_instance.add_hook_for_org(orgid, options=options)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->add_hook_for_org: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
options	Options2		[optional]

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

add_hook_for_project

InlineResponse2007 add_hook_for_project(orgid, projectid, options=options)

Add hook for project

Adds a new project level hook. A project level hook is only triggered by events from the specific project. NOTE: you must be a manager in the organization to add new hooks.

Hook Type Configuration Parameters

Type Configuration Options

web

url	Endpoint to submit POST request
encoding	Either `json` (default) or `form`
sslVerify	Verify SSL certificates of HTTPS endpoint
secret	Used to compute the SHA256 HMAC signature of the hook body and adds a `X-UnityCloudBuild-Signature` header to the payload

slack

url	Slack incoming webhook URL. Learn more at https://api.slack.com/incoming-webhooks

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier
options = swagger_client.Options6() # Options6 |  (optional)

try: 
    # Add hook for project
    api_response = api_instance.add_hook_for_project(orgid, projectid, options=options)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->add_hook_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
projectid	str	Project identifier
options	Options6		[optional]

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

delete_hook

str delete_hook(orgid, id)

Delete organization hook

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
id = 3.4 # float | Hook record identifier

try: 
    # Delete organization hook
    api_response = api_instance.delete_hook(orgid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->delete_hook: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
id	float	Hook record identifier

Return type

str

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

delete_hook_0

str delete_hook_0(orgid, projectid, id)

Delete project hook

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier
id = 3.4 # float | Hook record identifier

try: 
    # Delete project hook
    api_response = api_instance.delete_hook_0(orgid, projectid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->delete_hook_0: %s\n" % e)

Parameters

Name	Type	Description
orgid	str	Organization identifier
projectid	str	Project identifier
id	float	Hook record identifier

Return type

str

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

get_hook

InlineResponse2007 get_hook(orgid, id)

Get organization hook details

Get details of a hook by id

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
id = 3.4 # float | Hook record identifier

try: 
    # Get organization hook details
    api_response = api_instance.get_hook(orgid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->get_hook: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
id	float	Hook record identifier

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

get_hook_0

InlineResponse2007 get_hook_0(orgid, projectid, id)

Get project hook details

Get details of a hook by id

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier
id = 3.4 # float | Hook record identifier

try: 
    # Get project hook details
    api_response = api_instance.get_hook_0(orgid, projectid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->get_hook_0: %s\n" % e)

Parameters

Name	Type	Description
orgid	str	Organization identifier
projectid	str	Project identifier
id	float	Hook record identifier

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

list_hooks_for_org

list[InlineResponse2007] list_hooks_for_org(orgid)

List hooks for organization

List all hooks configured for the specified organization

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier

try: 
    # List hooks for organization
    api_response = api_instance.list_hooks_for_org(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->list_hooks_for_org: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier

Return type

list[InlineResponse2007]

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

list_hooks_for_project

list[InlineResponse2007] list_hooks_for_project(orgid, projectid)

List hooks for project

List all hooks configured for the specified project

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier

try: 
    # List hooks for project
    api_response = api_instance.list_hooks_for_project(orgid, projectid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->list_hooks_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
projectid	str	Project identifier

Return type

list[InlineResponse2007]

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

ping_hook

str ping_hook(orgid, id)

Ping an org hook

Send a ping event to an org hook.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
id = 3.4 # float | Hook record identifier

try: 
    # Ping an org hook
    api_response = api_instance.ping_hook(orgid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->ping_hook: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
id	float	Hook record identifier

Return type

str

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

ping_hook_0

str ping_hook_0(orgid, projectid, id)

Ping a project hook

Send a ping event to a project hook.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier
id = 3.4 # float | Hook record identifier

try: 
    # Ping a project hook
    api_response = api_instance.ping_hook_0(orgid, projectid, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->ping_hook_0: %s\n" % e)

Parameters

Name	Type	Description
orgid	str	Organization identifier
projectid	str	Project identifier
id	float	Hook record identifier

Return type

str

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

update_hook

InlineResponse2007 update_hook(orgid, id, options=options)

Update hook for organization

Update a new hook. NOTE: you must be a manager in the organization to update hooks.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
id = 3.4 # float | Hook record identifier
options = swagger_client.Options3() # Options3 |  (optional)

try: 
    # Update hook for organization
    api_response = api_instance.update_hook(orgid, id, options=options)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->update_hook: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
id	float	Hook record identifier
options	Options3		[optional]

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

update_hook_0

InlineResponse2007 update_hook_0(orgid, projectid, id, options=options)

Update hook for project

Update an existing hook. NOTE: you must be a manager of the project to update hooks.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: apikey
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhooksApi()
orgid = 'orgid_example' # str | Organization identifier
projectid = 'projectid_example' # str | Project identifier
id = 3.4 # float | Hook record identifier
options = swagger_client.Options7() # Options7 |  (optional)

try: 
    # Update hook for project
    api_response = api_instance.update_hook_0(orgid, projectid, id, options=options)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->update_hook_0: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier
projectid	str	Project identifier
id	float	Hook record identifier
options	Options7		[optional]

Return type

InlineResponse2007

Authorization

apikey, permissions

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain, text/html, text/csv

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

Files

WebhooksApi.md

Latest commit

History

WebhooksApi.md

File metadata and controls

swagger_client.WebhooksApi

add_hook_for_org

Hook Type Configuration Parameters

Example

Parameters

Return type

Authorization

HTTP request headers

add_hook_for_project

Hook Type Configuration Parameters

Example

Parameters

Return type

Authorization

HTTP request headers

delete_hook

Example

Parameters

Return type

Authorization

HTTP request headers

delete_hook_0

Example

Parameters

Return type

Authorization

HTTP request headers

get_hook

Example

Parameters

Return type

Authorization

HTTP request headers

get_hook_0

Example

Parameters

Return type

Authorization

HTTP request headers

list_hooks_for_org

Example

Parameters

Return type

Authorization

HTTP request headers

list_hooks_for_project

Example

Parameters

Return type

Authorization

HTTP request headers

ping_hook

Example

Parameters

Return type

Authorization

HTTP request headers

ping_hook_0

Example

Parameters

Return type

Authorization

HTTP request headers

update_hook

Example

Parameters

Return type

Authorization

HTTP request headers

update_hook_0

Example

Parameters

Return type

Authorization