Connectors Reference
Traction Guest is a leading visitor management solution that tracks visitor invites and sign ins. Actions taken in Traction Guest such as a visitor signing in, an invite being sent by a host, or a visitor matching on a watchlist can trigger actions in other connectors.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Deletes a webhook |
|
Name |
Summary |
|
When a guest is invited |
|
|
When a guest signs in |
|
|
CreateSignoutWebhook (CreateSignoutWebhookParameterBody body) |
When a guest signs out |
|
CreateWatchlistWebhook (CreateWatchlistWebhookParameterBody body) |
When a guest triggers a watchlist |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Deletes a webhook
Description: Unsubscribe a specific webhook
Syntax:
TractionGuest.DeleteWebhook (string hook_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
hook_id |
string (ID of the webhook being deleted) |
ID of the webhook being deleted |
True |
Returns:
Summary: When a guest is invited
Description: This trigger is executed when an invite is created in Guest
Syntax:
TractionGuest.CreateInviteWebhook (CreateInviteWebhookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateInviteWebhookParameterBody
|
|
True |
Returns:
Type:WebhookCreatedResponseRoot Type for WebhookCreatedResponse
Title: Root Type for WebhookCreatedResponse
Description: The root of the WebhookCreatedResponse type's schema.
Summary: When a guest signs in
Description: This action will trigger when a guest signs in, either at an iPad or in the Guest web interface
Syntax:
TractionGuest.CreateSigninWebhook (CreateSigninWebhookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateSigninWebhookParameterBody
|
|
True |
Returns:
Type:WebhookCreatedResponseRoot Type for WebhookCreatedResponse
Title: Root Type for WebhookCreatedResponse
Description: The root of the WebhookCreatedResponse type's schema.
Summary: When a guest signs out
Description: This operation is triggered when a guest signs out
Syntax:
TractionGuest.CreateSignoutWebhook (CreateSignoutWebhookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateSignoutWebhookParameterBody
|
|
True |
Returns:
Type:WebhookCreatedResponseRoot Type for WebhookCreatedResponse
Title: Root Type for WebhookCreatedResponse
Description: The root of the WebhookCreatedResponse type's schema.
Summary: When a guest triggers a watchlist
Description: This action will fire when a guest is flagged on a watchlist
Syntax:
TractionGuest.CreateWatchlistWebhook (CreateWatchlistWebhookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateWatchlistWebhookParameterBody
|
|
True |
Returns:
Type:WebhookCreatedResponseRoot Type for WebhookCreatedResponse
Title: Root Type for WebhookCreatedResponse
Description: The root of the WebhookCreatedResponse type's schema.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
Values: [signin, signout, watchlist, invite] |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
Values: [signin, signout, watchlist, invite] |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
Values: [signin, signout, watchlist, invite] |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
Values: [signin, signout, watchlist, invite] |
|
url |
string
|
|
Summary:
Description: The root of the WebhookCreatedResponse type's schema.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|