NewWebHook.md

NewWebHook

Properties

Name	Type	Description	Notes
name	str	The name of the webhook.
monitor_fields	List[str]	A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated.	[optional]
post_fields	object	An object map of field ID or alias to the external name used in the webhook payload (e.g. `{"firstName": "First Name"}`). Omit or send an empty object to include no extra fields.	[optional]
url	str	The url the webhook should send data to (must begin with https://).
format	str	The payload format the webhook uses. Required.
include_company_domain	bool	If set to true, the company domain will be added to the webhook request header.	[optional]
events	List[WebhookEventType]	Events that trigger this webhook. Defaults to ['employee_with_fields.updated', 'employee_with_fields.deleted', 'employee_with_fields.created'] if not specified. Cannot mix employee_with_fields events with employee events.	[optional]

Example

from bamboohr_sdk.models.new_web_hook import NewWebHook

# TODO update the JSON string below
json = "{}"
# create an instance of NewWebHook from a JSON string
new_web_hook_instance = NewWebHook.from_json(json)
# print the JSON string representation of the object
print(NewWebHook.to_json())

# convert the object into a dict
new_web_hook_dict = new_web_hook_instance.to_dict()
# create an instance of NewWebHook from a dict
new_web_hook_from_dict = NewWebHook.from_dict(new_web_hook_dict)

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