PUT
/
webhooks
/
{id}
Update a webhook subscription
curl --request PUT \
  --url https://api.smokeball.com/webhooks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "key": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "name": "Listen to matter and contact changes",
  "eventTypes": [
    "matter.updated",
    "contact.created"
  ],
  "eventNotificationUrl": "http://yourdomain.com/notify"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "name": "Listen to matter and contact changes",
  "eventTypes": [
    "matter.updated",
    "contact.created"
  ],
  "eventNotificationUrl": "http://yourdomain.com/notify",
  "createdDateUtc": "2022-04-23T14:00:00Z",
  "updatedDateUtc": "2022-04-23T14:00:00Z",
  "lastUpdated": 637847425252027400
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Body

​
key
string | null

Unique key used for creating signature header in webhook notification requests.

Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

​
name
string | null

Name or description of the webhook subscription.

Example:

"Listen to matter and contact changes"

​
eventTypes
string[] | null

The event types that the webhook subscription should be subscribed to.

Example:
["matter.updated", "contact.created"]
​
eventNotificationUrl
string | null

The uri to notify when an event has occurred.

Example:

"http://yourdomain.com/notify"

Response

When request is successful. Returns updated webhook subscriptions.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
accountId
string | null

Unique identifier of the associated account.

Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

​
name
string | null

Name or description of the subscription.

Example:

"Listen to matter and contact changes"

​
eventTypes
string[] | null

The event types that the webhook subscription is subscribed to.

Example:
["matter.updated", "contact.created"]
​
eventNotificationUrl
string | null

The uri to notify when an event has occurred.

Example:

"http://yourdomain.com/notify"

​
createdDateUtc
string<date-time>

The webhook subscription creation date.

Example:

"2022-04-23T14:00:00Z"

​
updatedDateUtc
string<date-time>

The webhook subscription last updated date.

Example:

"2022-04-23T14:00:00Z"

​
lastUpdated
integer

Last updated timestamp

Example:

637847425252027400