Skip to main content
Server path: /dialpad-subscriptions | Type: Application | PCID required: Yes

Tools

ToolDescription
dialpad_subscriptions_webhook_agent_status_event_subscription_createAgent Status — Create
dialpad_subscriptions_webhook_agent_status_event_subscription_deleteAgent Status — Delete
dialpad_subscriptions_webhook_agent_status_event_subscription_getAgent Status — Get
dialpad_subscriptions_webhook_agent_status_event_subscription_listAgent Status — List
dialpad_subscriptions_webhook_agent_status_event_subscription_updateAgent Status — Update
dialpad_subscriptions_webhook_call_event_subscription_createCall Event — Create
dialpad_subscriptions_webhook_call_event_subscription_deleteCall Event — Delete
dialpad_subscriptions_webhook_call_event_subscription_getCall Event — Get
dialpad_subscriptions_webhook_call_event_subscription_listCall Event — List
dialpad_subscriptions_webhook_call_event_subscription_updateCall Event — Update
dialpad_subscriptions_webhook_change_log_event_subscription_createChange Log — Create
dialpad_subscriptions_webhook_change_log_event_subscription_deleteChange Log — Delete
dialpad_subscriptions_webhook_change_log_event_subscription_getChange Log — Get
dialpad_subscriptions_webhook_change_log_event_subscription_listChange Log — List
dialpad_subscriptions_webhook_change_log_event_subscription_updateChange Log — Update
dialpad_subscriptions_webhook_channel_event_subscription_createChannel Event — Create
dialpad_subscriptions_webhook_channel_event_subscription_deleteChannel Event — Delete
dialpad_subscriptions_webhook_channel_event_subscription_getChannel Event — Get
dialpad_subscriptions_webhook_channel_event_subscription_listChannel Event — List
dialpad_subscriptions_webhook_channel_event_subscription_updateChannel Event — Update
dialpad_subscriptions_webhook_contact_event_subscription_createContact Event — Create
dialpad_subscriptions_webhook_contact_event_subscription_deleteContact Event — Delete
dialpad_subscriptions_webhook_contact_event_subscription_getContact Event — Get
dialpad_subscriptions_webhook_contact_event_subscription_listContact Event — List
dialpad_subscriptions_webhook_contact_event_subscription_updateContact Event — Update
dialpad_subscriptions_webhook_fax_event_subscription_createFax Event — Create
dialpad_subscriptions_webhook_fax_event_subscription_deleteFax Event — Delete
dialpad_subscriptions_webhook_fax_event_subscription_getFax Event — Get
dialpad_subscriptions_webhook_fax_event_subscription_listFax Event — List
dialpad_subscriptions_webhook_fax_event_subscription_updateFax Event — Update
dialpad_subscriptions_webhook_sms_event_subscription_createSMS Event — Create
dialpad_subscriptions_webhook_sms_event_subscription_deleteSMS Event — Delete
dialpad_subscriptions_webhook_sms_event_subscription_getSMS Event — Get
dialpad_subscriptions_webhook_sms_event_subscription_listSMS Event — List
dialpad_subscriptions_webhook_sms_event_subscription_updateSMS Event — Update

dialpad_subscriptions_webhook_agent_status_event_subscription_create

Agent Status — Create Parameters:
ParameterTypeRequiredDefaultDescription
agent_typestringYesThe agent type this event subscription subscribes to.
enabledbooleanNoWhether or not this agent status event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

dialpad_subscriptions_webhook_agent_status_event_subscription_delete

Agent Status — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_agent_status_event_subscription_get

Agent Status — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_agent_status_event_subscription_list

Agent Status — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.

dialpad_subscriptions_webhook_agent_status_event_subscription_update

Agent Status — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
agent_typestringNoThe agent type this event subscription subscribes to.
enabledbooleanNoWhether or not this agent status event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

dialpad_subscriptions_webhook_call_event_subscription_create

Call Event — Create Parameters:
ParameterTypeRequiredDefaultDescription
call_statesstring[]NoThe call event subscription’s list of call states.
enabledbooleanNoWhether or not the call event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
group_calls_onlybooleanNoCall event subscription for group calls only.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target type.

dialpad_subscriptions_webhook_call_event_subscription_delete

Call Event — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_call_event_subscription_get

Call Event — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_call_event_subscription_list

Call Event — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
target_typestringNoTarget’s type.
target_idintegerNoThe target’s id.

dialpad_subscriptions_webhook_call_event_subscription_update

Call Event — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
call_statesstring[]NoThe call event subscription’s list of call states.
enabledbooleanNoWhether or not the call event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
group_calls_onlybooleanNoCall event subscription for group calls only.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target type.

dialpad_subscriptions_webhook_change_log_event_subscription_create

Change Log — Create Parameters:
ParameterTypeRequiredDefaultDescription
enabledbooleanNoWhether or not this change log event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

dialpad_subscriptions_webhook_change_log_event_subscription_delete

Change Log — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_change_log_event_subscription_get

Change Log — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_change_log_event_subscription_list

Change Log — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.

dialpad_subscriptions_webhook_change_log_event_subscription_update

Change Log — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
enabledbooleanNoWhether or not the change log event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

dialpad_subscriptions_webhook_channel_event_subscription_create

Channel Event — Create Parameters:
ParameterTypeRequiredDefaultDescription
directionstringYesThe message direction this event subscription subscribes to.
enabledbooleanNoWhether or not the channel event subscription is enabled.
endpoint_idintegerYesThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
target_idintegerYesThe ID of the specific target for which events should be sent.

dialpad_subscriptions_webhook_channel_event_subscription_delete

Channel Event — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_channel_event_subscription_get

Channel Event — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_channel_event_subscription_list

Channel Event — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.

dialpad_subscriptions_webhook_channel_event_subscription_update

Channel Event — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
directionstringNoThe channel direction this event subscription subscribes to.
enabledbooleanNoWhether or not the channel event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
target_idintegerNoThe ID of the specific target for which events should be sent.

dialpad_subscriptions_webhook_contact_event_subscription_create

Contact Event — Create Parameters:
ParameterTypeRequiredDefaultDescription
contact_typestringYesThe contact type this event subscription subscribes to.
enabledbooleanNoWhether or not the contact event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

dialpad_subscriptions_webhook_contact_event_subscription_delete

Contact Event — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_contact_event_subscription_get

Contact Event — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_contact_event_subscription_list

Contact Event — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.

dialpad_subscriptions_webhook_contact_event_subscription_update

Contact Event — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
contact_typestringYesThe contact type this event subscription subscribes to.
enabledbooleanNoWhether or not the contact event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

dialpad_subscriptions_webhook_fax_event_subscription_create

Fax Event — Create Parameters:
ParameterTypeRequiredDefaultDescription
directionstringYesThe fax direction this event subscription subscribes to.
enabledbooleanNoWhether or not the fax event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
statusbooleanNoWhether or not to update on each fax message status.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target’s type.

dialpad_subscriptions_webhook_fax_event_subscription_delete

Fax Event — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_fax_event_subscription_get

Fax Event — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_fax_event_subscription_list

Fax Event — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
target_idintegerNoThe target’s id.
target_typestringNoThe target’s type.

dialpad_subscriptions_webhook_fax_event_subscription_update

Fax Event — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
directionstringNoThe fax direction this event subscription subscribes to.
enabledbooleanNoWhether or not the fax event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
statusbooleanNoWhether or not to update on each fax message status.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target’s type.

dialpad_subscriptions_webhook_sms_event_subscription_create

SMS Event — Create Parameters:
ParameterTypeRequiredDefaultDescription
directionstringYesThe SMS direction this event subscription subscribes to.
enabledbooleanNoWhether or not the SMS event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
include_internalbooleanNoWhether or not to trigger SMS events for SMS sent between two users from the same company.
statusbooleanNoWhether or not to update on each SMS delivery status.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target’s type.

dialpad_subscriptions_webhook_sms_event_subscription_delete

SMS Event — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_sms_event_subscription_get

SMS Event — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.

dialpad_subscriptions_webhook_sms_event_subscription_list

SMS Event — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
target_typestringNoTarget’s type.
target_idintegerNoThe target’s id.

dialpad_subscriptions_webhook_sms_event_subscription_update

SMS Event — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe event subscription’s ID, which is generated after creating an event subscription successfully.
directionstringNoThe SMS direction this event subscription subscribes to.
enabledbooleanNoWhether or not the SMS event subscription is enabled.
endpoint_idintegerNoThe logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
include_internalbooleanNoWhether or not to trigger SMS events for SMS sent between two users from the same company.
statusbooleanNoWhether or not to update on each SMS delivery status.
target_idintegerNoThe ID of the specific target for which events should be sent.
target_typestringNoThe target’s type.