/dialpad-subscriptions | Type: Application | PCID required: Yes
Tools
dialpad_subscriptions_webhook_agent_status_event_subscription_create
Agent Status — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_type | string | Yes | — | The agent type this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not this agent status event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
agent_type | string | No | — | The agent type this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not this agent status event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_states | string[] | No | — | The call event subscription’s list of call states. |
enabled | boolean | No | — | Whether or not the call event subscription is enabled. |
endpoint_id | integer | No | — | The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. |
group_calls_only | boolean | No | — | Call event subscription for group calls only. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target type. |
dialpad_subscriptions_webhook_call_event_subscription_delete
Call Event — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_call_event_subscription_get
Call Event — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_call_event_subscription_list
Call Event — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
target_type | string | No | — | Target’s type. |
target_id | integer | No | — | The target’s id. |
dialpad_subscriptions_webhook_call_event_subscription_update
Call Event — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
call_states | string[] | No | — | The call event subscription’s list of call states. |
enabled | boolean | No | — | Whether or not the call event subscription is enabled. |
endpoint_id | integer | No | — | The 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_only | boolean | No | — | Call event subscription for group calls only. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target type. |
dialpad_subscriptions_webhook_change_log_event_subscription_create
Change Log — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enabled | boolean | No | — | Whether or not this change log event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
enabled | boolean | No | — | Whether or not the change log event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
direction | string | Yes | — | The message direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the channel event subscription is enabled. |
endpoint_id | integer | Yes | — | The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. |
target_id | integer | Yes | — | The ID of the specific target for which events should be sent. |
dialpad_subscriptions_webhook_channel_event_subscription_delete
Channel Event — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_channel_event_subscription_get
Channel Event — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_channel_event_subscription_list
Channel Event — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
direction | string | No | — | The channel direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the channel event subscription is enabled. |
endpoint_id | integer | No | — | The 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_id | integer | No | — | The ID of the specific target for which events should be sent. |
dialpad_subscriptions_webhook_contact_event_subscription_create
Contact Event — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_type | string | Yes | — | The contact type this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the contact event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_contact_event_subscription_get
Contact Event — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_contact_event_subscription_list
Contact Event — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
contact_type | string | Yes | — | The contact type this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the contact event subscription is enabled. |
endpoint_id | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
direction | string | Yes | — | The fax direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the fax event subscription is enabled. |
endpoint_id | integer | No | — | The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. |
status | boolean | No | — | Whether or not to update on each fax message status. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target’s type. |
dialpad_subscriptions_webhook_fax_event_subscription_delete
Fax Event — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_fax_event_subscription_get
Fax Event — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_fax_event_subscription_list
Fax Event — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
target_id | integer | No | — | The target’s id. |
target_type | string | No | — | The target’s type. |
dialpad_subscriptions_webhook_fax_event_subscription_update
Fax Event — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
direction | string | No | — | The fax direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the fax event subscription is enabled. |
endpoint_id | integer | No | — | The 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. |
status | boolean | No | — | Whether or not to update on each fax message status. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target’s type. |
dialpad_subscriptions_webhook_sms_event_subscription_create
SMS Event — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
direction | string | Yes | — | The SMS direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the SMS event subscription is enabled. |
endpoint_id | integer | No | — | The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully. |
include_internal | boolean | No | — | Whether or not to trigger SMS events for SMS sent between two users from the same company. |
status | boolean | No | — | Whether or not to update on each SMS delivery status. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target’s type. |
dialpad_subscriptions_webhook_sms_event_subscription_delete
SMS Event — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_sms_event_subscription_get
SMS Event — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
dialpad_subscriptions_webhook_sms_event_subscription_list
SMS Event — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
target_type | string | No | — | Target’s type. |
target_id | integer | No | — | The target’s id. |
dialpad_subscriptions_webhook_sms_event_subscription_update
SMS Event — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The event subscription’s ID, which is generated after creating an event subscription successfully. |
direction | string | No | — | The SMS direction this event subscription subscribes to. |
enabled | boolean | No | — | Whether or not the SMS event subscription is enabled. |
endpoint_id | integer | No | — | The 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_internal | boolean | No | — | Whether or not to trigger SMS events for SMS sent between two users from the same company. |
status | boolean | No | — | Whether or not to update on each SMS delivery status. |
target_id | integer | No | — | The ID of the specific target for which events should be sent. |
target_type | string | No | — | The target’s type. |

