dialpad-subscriptions

Event Subscriptions

Server path: /dialpad-subscriptions | Type: Application | PCID required: Yes

Tools

Tool	Description
dialpad_subscriptions_webhook_agent_status_event_subscription_create	Agent Status — Create
dialpad_subscriptions_webhook_agent_status_event_subscription_delete	Agent Status — Delete
dialpad_subscriptions_webhook_agent_status_event_subscription_get	Agent Status — Get
dialpad_subscriptions_webhook_agent_status_event_subscription_list	Agent Status — List
dialpad_subscriptions_webhook_agent_status_event_subscription_update	Agent Status — Update
dialpad_subscriptions_webhook_call_event_subscription_create	Call Event — Create
dialpad_subscriptions_webhook_call_event_subscription_delete	Call Event — Delete
dialpad_subscriptions_webhook_call_event_subscription_get	Call Event — Get
dialpad_subscriptions_webhook_call_event_subscription_list	Call Event — List
dialpad_subscriptions_webhook_call_event_subscription_update	Call Event — Update
dialpad_subscriptions_webhook_change_log_event_subscription_create	Change Log — Create
dialpad_subscriptions_webhook_change_log_event_subscription_delete	Change Log — Delete
dialpad_subscriptions_webhook_change_log_event_subscription_get	Change Log — Get
dialpad_subscriptions_webhook_change_log_event_subscription_list	Change Log — List
dialpad_subscriptions_webhook_change_log_event_subscription_update	Change Log — Update
dialpad_subscriptions_webhook_channel_event_subscription_create	Channel Event — Create
dialpad_subscriptions_webhook_channel_event_subscription_delete	Channel Event — Delete
dialpad_subscriptions_webhook_channel_event_subscription_get	Channel Event — Get
dialpad_subscriptions_webhook_channel_event_subscription_list	Channel Event — List
dialpad_subscriptions_webhook_channel_event_subscription_update	Channel Event — Update
dialpad_subscriptions_webhook_contact_event_subscription_create	Contact Event — Create
dialpad_subscriptions_webhook_contact_event_subscription_delete	Contact Event — Delete
dialpad_subscriptions_webhook_contact_event_subscription_get	Contact Event — Get
dialpad_subscriptions_webhook_contact_event_subscription_list	Contact Event — List
dialpad_subscriptions_webhook_contact_event_subscription_update	Contact Event — Update
dialpad_subscriptions_webhook_fax_event_subscription_create	Fax Event — Create
dialpad_subscriptions_webhook_fax_event_subscription_delete	Fax Event — Delete
dialpad_subscriptions_webhook_fax_event_subscription_get	Fax Event — Get
dialpad_subscriptions_webhook_fax_event_subscription_list	Fax Event — List
dialpad_subscriptions_webhook_fax_event_subscription_update	Fax Event — Update
dialpad_subscriptions_webhook_sms_event_subscription_create	SMS Event — Create
dialpad_subscriptions_webhook_sms_event_subscription_delete	SMS Event — Delete
dialpad_subscriptions_webhook_sms_event_subscription_get	SMS Event — Get
dialpad_subscriptions_webhook_sms_event_subscription_list	SMS Event — List
dialpad_subscriptions_webhook_sms_event_subscription_update	SMS Event — Update

---

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	null	No	—	Whether or not this agent status event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agent_type": {
      "type": "string",
      "description": "The agent type this event subscription subscribes to.",
      "enum": [
        "callcenter"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not this agent status event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    }
  },
  "required": [
    "PCID",
    "agent_type"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	The agent type this event subscription subscribes to.
enabled	boolean	null	No	—	Whether or not this agent status event subscription is enabled.
endpoint_id	integer	null	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "agent_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The agent type this event subscription subscribes to.",
      "enum": [
        "callcenter"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not this agent status event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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	null	No	—	Whether or not the call event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
group_calls_only	boolean	null	No	—	Call event subscription for group calls only.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "call_states": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "admin",
          "admin_recording",
          "ai_playbook",
          "all",
          "barge",
          "blocked",
          "call_moments",
          "call_transcription",
          "calling",
          "connected",
          "csat",
          "dispositions",
          "hangup",
          "hold",
          "merged",
          "missed",
          "monitor",
          "parked",
          "pcsat",
          "postcall",
          "preanswer",
          "queued",
          "recap_action_items",
          "recap_outcome",
          "recap_purposes",
          "recap_summary",
          "recording",
          "ringing",
          "takeover",
          "transcription",
          "voicemail",
          "voicemail_uploaded"
        ]
      },
      "description": "The call event subscription's list of call states."
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the call event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    },
    "group_calls_only": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Call event subscription for group calls only."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "target_type": {
      "type": "string",
      "description": "Target's type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    },
    "target_id": {
      "type": "integer",
      "description": "The target's id."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	Whether or not the call event subscription is enabled.
endpoint_id	integer	null	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	null	No	—	Call event subscription for group calls only.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "call_states": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "admin",
          "admin_recording",
          "ai_playbook",
          "all",
          "barge",
          "blocked",
          "call_moments",
          "call_transcription",
          "calling",
          "connected",
          "csat",
          "dispositions",
          "hangup",
          "hold",
          "merged",
          "missed",
          "monitor",
          "parked",
          "pcsat",
          "postcall",
          "preanswer",
          "queued",
          "recap_action_items",
          "recap_outcome",
          "recap_purposes",
          "recap_summary",
          "recording",
          "ringing",
          "takeover",
          "transcription",
          "voicemail",
          "voicemail_uploaded"
        ]
      },
      "description": "The call event subscription's list of call states."
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the call event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Call event subscription for group calls only."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

dialpad_subscriptions_webhook_change_log_event_subscription_create

Change Log — Create

Parameters:

Parameter	Type	Required	Default	Description
enabled	boolean	null	No	—	Whether or not this change log event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not this change log event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	Whether or not the change log event subscription is enabled.
endpoint_id	integer	null	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the change log event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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	null	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "direction": {
      "type": "string",
      "description": "The message direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the channel event subscription is enabled."
    },
    "endpoint_id": {
      "type": "integer",
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    },
    "target_id": {
      "type": "integer",
      "description": "The ID of the specific target for which events should be sent."
    }
  },
  "required": [
    "PCID",
    "direction",
    "endpoint_id",
    "target_id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	The channel direction this event subscription subscribes to.
enabled	boolean	null	No	—	Whether or not the channel event subscription is enabled.
endpoint_id	integer	null	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	null	No	—	The ID of the specific target for which events should be sent.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "direction": {
      "type": [
        "string",
        "null"
      ],
      "description": "The channel direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the channel event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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	null	No	—	Whether or not the contact event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_type": {
      "type": "string",
      "description": "The contact type this event subscription subscribes to.",
      "enum": [
        "all",
        "google",
        "local",
        "microsoft",
        "shared"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the contact event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    }
  },
  "required": [
    "PCID",
    "contact_type"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	Whether or not the contact event subscription is enabled.
endpoint_id	integer	null	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "contact_type": {
      "type": "string",
      "description": "The contact type this event subscription subscribes to.",
      "enum": [
        "all",
        "google",
        "local",
        "microsoft",
        "shared"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the contact event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "id",
    "contact_type"
  ]
}

---

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	null	No	—	Whether or not the fax event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
status	boolean	null	No	—	Whether or not to update on each fax message status.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target’s type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "direction": {
      "type": "string",
      "description": "The fax direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the fax event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    },
    "status": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to update on each fax message status."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target's type.",
      "enum": [
        "callcenter",
        "department",
        "office",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "direction"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "target_id": {
      "type": "integer",
      "description": "The target's id."
    },
    "target_type": {
      "type": "string",
      "description": "The target's type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	The fax direction this event subscription subscribes to.
enabled	boolean	null	No	—	Whether or not the fax event subscription is enabled.
endpoint_id	integer	null	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	null	No	—	Whether or not to update on each fax message status.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target’s type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "direction": {
      "type": [
        "string",
        "null"
      ],
      "description": "The fax direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the fax event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to update on each fax message status."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target's type.",
      "enum": [
        "callcenter",
        "department",
        "office",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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	null	No	—	Whether or not the SMS event subscription is enabled.
endpoint_id	integer	null	No	—	The logging endpoint’s ID, which is generated after creating a webhook or websocket successfully.
include_internal	boolean	null	No	—	Whether or not to trigger SMS events for SMS sent between two users from the same company.
status	boolean	null	No	—	Whether or not to update on each SMS delivery status.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target’s type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "direction": {
      "type": "string",
      "description": "The SMS direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the SMS event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
    },
    "include_internal": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to trigger SMS events for SMS sent between two users from the same company."
    },
    "status": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to update on each SMS delivery status."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target's type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "direction"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "target_type": {
      "type": "string",
      "description": "Target's type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    },
    "target_id": {
      "type": "integer",
      "description": "The target's id."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	null	No	—	The SMS direction this event subscription subscribes to.
enabled	boolean	null	No	—	Whether or not the SMS event subscription is enabled.
endpoint_id	integer	null	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	null	No	—	Whether or not to trigger SMS events for SMS sent between two users from the same company.
status	boolean	null	No	—	Whether or not to update on each SMS delivery status.
target_id	integer	null	No	—	The ID of the specific target for which events should be sent.
target_type	string	null	No	—	The target’s type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The event subscription's ID, which is generated after creating an event subscription successfully."
    },
    "direction": {
      "type": [
        "string",
        "null"
      ],
      "description": "The SMS direction this event subscription subscribes to.",
      "enum": [
        "all",
        "inbound",
        "outbound"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the SMS event subscription is enabled."
    },
    "endpoint_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "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": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to trigger SMS events for SMS sent between two users from the same company."
    },
    "status": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to update on each SMS delivery status."
    },
    "target_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the specific target for which events should be sent."
    },
    "target_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target's type.",
      "enum": [
        "callcenter",
        "callrouter",
        "channel",
        "coachinggroup",
        "coachingteam",
        "department",
        "office",
        "room",
        "staffgroup",
        "unknown",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}