Webhooks

Webhooks are a way to receive notifications when certain events happen in your Spoke account. For more information about webhooks, see Webhook Events.

List webhooks

GET

https://integration.spokephone.com

/webhooks

List all webhooks in your organisation.

This endpoint supports paging. By default the API will return 100 webhooks, configurable up to a maximum of 1000 webhooks at a time. If the result from a previous call includes a next value in the result set you can use the value returned as the next parameter in the query string to retrieve the next page of results.

List webhooks › query Parameters

limit

limit

The maximum number of webhooks to return. Default to 100, maximum is 1000

next

Optional next token for object pagination

List webhooks › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List webhooks › Responses

Webhooks

GetWebhooksResponse

object · required

object[] · required

The list of webhooks. May be empty if no webhooks are found.

Create a webhook

POST

https://integration.spokephone.com

/webhooks

Create a new webhook.

The total number of webhooks cannot exceed your account level limit. By default each account can create up to 10 webhooks. Please contact support with your specific use case to increase the limit.

Create a webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Create a webhook › Request Body optional

CreateWebhookRequestBody

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

enabled

boolean

Whether the webhook is enabled. Default value is true

mode

string · enum

The webhook mode. Default value is production

Enum values:

production

test

Create a webhook › Responses

Successfully created webhook

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

Get webhook

GET

https://integration.spokephone.com

/webhooks/{id}

Retrieve the webhook.

Get webhook › path Parameters

id

id · required

The webhook ID

Get webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get webhook › Responses

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

Update webhook

PUT

https://integration.spokephone.com

/webhooks/{id}

Update an existing webhook.

Update webhook › path Parameters

id

id · required

The webhook ID

Update webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update webhook › Request Body optional

UpdateWebhookRequestBody

description

string

The description of the webhook

enabled

boolean

Whether the webhook is enabled. Default value is true

events

string[]

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

mode

string · enum

The webhook mode. Default value is production

Enum values:

production

test

url

string

The URL of the webhook. Must be a valid HTTPS URL

Update webhook › Responses

Successfully updated webhook

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

PUT/webhooks/{id}

curl https://integration.spokephone.com/webhooks/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "enabled": true,
  "events": [
    "string"
  ],
  "mode": "production",
  "url": "url"
}'

Example Request Body

{
  "description": "description",
  "enabled": true,
  "events": [
    "string"
  ],
  "mode": "production",
  "url": "url"
}

json

Example Responses

{
  "createdAt": "createdAt",
  "createdTimestamp": 0,
  "description": "description",
  "enabled": true,
  "events": [
    "string"
  ],
  "id": "id",
  "mode": "production",
  "signingSecret": "signingSecret",
  "url": "url"
}

json

application/json

Delete webhook

DELETE

https://integration.spokephone.com

/webhooks/{id}

Delete the specified webhook.

Delete webhook › path Parameters

id

id · required

The webhook ID

Delete webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete webhook › Responses

Successfully deleted the webhook

No data returned

Content Analysis Trunks

List webhooks

GET

https://integration.spokephone.com

/webhooks

List all webhooks in your organisation.

List webhooks › query Parameters

limit

limit

The maximum number of webhooks to return. Default to 100, maximum is 1000

next

Optional next token for object pagination

List webhooks › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List webhooks › Responses

Webhooks

GetWebhooksResponse

object · required

object[] · required

The list of webhooks. May be empty if no webhooks are found.

Create a webhook

POST

https://integration.spokephone.com

/webhooks

Create a new webhook.

The total number of webhooks cannot exceed your account level limit. By default each account can create up to 10 webhooks. Please contact support with your specific use case to increase the limit.

Create a webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Create a webhook › Request Body optional

CreateWebhookRequestBody

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

enabled

boolean

Whether the webhook is enabled. Default value is true

mode

string · enum

The webhook mode. Default value is production

Enum values:

production

test

Create a webhook › Responses

Successfully created webhook

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

Get webhook

GET

https://integration.spokephone.com

/webhooks/{id}

Retrieve the webhook.

Get webhook › path Parameters

id

id · required

The webhook ID

Get webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get webhook › Responses

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

Update webhook

PUT

https://integration.spokephone.com

/webhooks/{id}

Update an existing webhook.

Update webhook › path Parameters

id

id · required

The webhook ID

Update webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update webhook › Request Body optional

UpdateWebhookRequestBody

description

string

The description of the webhook

enabled

boolean

Whether the webhook is enabled. Default value is true

events

string[]

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

mode

string · enum

The webhook mode. Default value is production

Enum values:

production

test

url

string

The URL of the webhook. Must be a valid HTTPS URL

Update webhook › Responses

Successfully updated webhook

Webhook

createdAt

string · required

Date/Time (UTC - ISO8601 format) when the webhook was created

createdTimestamp

number · required

Unix timestamp when the webhook was created

enabled

boolean · required

Whether the webhook is enabled. Default value is true

events

string[] · required

The list of events the webhook is subscribed to

Possible values include:

call.started
call.answered
call.not_answered
call.hungup
call.ended
call.recording.available
call.voicemail.available
call.note.created
call.highlight.created
call.highlight.recording_available
call.contact_assigned
call.contact_assigned_with_add
call.contact_assigned_with_update
call.form.started
call.form.submitted
conversation.inactive
conversation.closed
conversation.message.created
user.availability.updated
team.availability.updated
transcript.created

id

string · required

ID of the webhook

mode

string · enum · required

The webhook mode. Default value is production

Enum values:

production

test

signingSecret

string · required

Signing secret used to sign the webhook requests

url

string · required

The URL of the webhook. Must be a valid HTTPS URL

description

string

The description of the webhook

Delete webhook

DELETE

https://integration.spokephone.com

/webhooks/{id}

Delete the specified webhook.

Delete webhook › path Parameters

id

id · required

The webhook ID

Delete webhook › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete webhook › Responses

Successfully deleted the webhook

No data returned