PATCH /webhooks/:id — gsmtasks-project-api

account_roles9

accounts22

addons2

authenticate1

billing15

client_roles6

clients5

configurations1

contact_address_exports1

contact_address_import3

contact_addresses5

devices3

docs1

documents5

emails7

exports6

file_uploads3

formrules6

integrations1

metafields6

notification_templates7

notifications3

orders5

password_change1

password_reset1

password_reset_confirm1

push_notifications7

recurrences5

register1

reports1

reviews3

route_optimizations8

routes6

scenes4

signatures5

sms7

task_address_features2

task_commands4

task_event_tracks2

task_events2

task_exports1

task_forms6

task_import3

task_import_mapping3

task_metadatas2

tasks21

time_location_features6

time_locations3

trackers6

users10

users_on_duty_log3

webhooks8

worker_features2

worker_tracks1

working_state3

webhooks

patch/webhooks/{id}/

Path parameters

idstring uuid required

A UUID string identifying this webhook.

Query parameters

format'json' | 'xlsx'

Request body

idstring uuid

urlstring uri

accountstring uri

namestring

version'2.4.13' | '2.4.12' | '2.4.11' | '2.4.10' | '2.4.9' | '2.4.8' | '2.4.7' | '2.4.6' | '2.4.5' | '2.4.4' | '2.4.3' | '2.4.2' | '2.4.1' | '2.3.5' | '2.3.4' | '2.3.3' | '2.3.2' | '2.3.1' | '2.3.0' | '2.2.6' | '2.2.5' | '2.2.4' | '2.2.3' | '2.2.2' | '2.2.1' | '2.2.0' | '2.1.1' | '2.1.0' | '2.0.0' | '1.1.0' | '1.0.0'

state'inactive' | 'active' | 'disabled'

headersobject

targetstring uri

task_eventsboolean

document_eventsboolean

signature_eventsboolean

review_eventsboolean

notification_emailsstring[]

failure_countinteger

disable_messagestring

shared_secretstring

activated_atstring date-time

disabled_atstring date-time

created_atstring date-time

updated_atstring date-time

Changes

Changed in 6 of the 6 revisions of this API.392677

Jul 13, 20262557a8fec76425See the full diff
- ●
  added the new 2.4.13 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.13)
  response-property-enum-value-added
- ●
  added the new 2.4.13 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.13)
  response-property-enum-value-added
- ○
  added the new 2.4.13 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.13 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.13 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status 200
  response-media-type-name-changed
Oct 13, 2022b89c1b3e6d0925See the full diff
- ●
  added the new 2.4.12 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.12)
  response-property-enum-value-added
- ●
  added the new 2.4.12 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.12)
  response-property-enum-value-added
- ○
  added the new 2.4.12 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.12 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.12 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status 200
  response-media-type-name-changed
Sep 20, 20222823b16250b725See the full diff
- ●
  added the new 2.4.11 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.11)
  response-property-enum-value-added
- ●
  added the new 2.4.11 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.11)
  response-property-enum-value-added
- ○
  added the new 2.4.11 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.11 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.11 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  media type application/json; version=2.4.10 was changed to application/json; version=2.4.11 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.4.10 was changed to application/xlsx; version=2.4.11 for the response status 200
  response-media-type-name-changed
Sep 16, 20220254944080621017See the full diff
- ●
  added the new 2.4.10 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.10 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.6 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.6 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.7 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.7 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.8 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.8 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.9 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.10)
  response-property-enum-value-added
- ●
  added the new 2.4.9 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.10)
  response-property-enum-value-added
- ○
  added the new 2.4.10 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.10 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.10 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.6 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.6 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.6 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.7 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.7 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.7 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.8 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.8 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.8 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.9 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.9 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.9 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  media type application/json; version=2.4.5 was changed to application/json; version=2.4.10 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.4.5 was changed to application/xlsx; version=2.4.10 for the response status 200
  response-media-type-name-changed
Sep 8, 2022486e2fd12f8f1017See the full diff
- ●
  added the new 2.4.1 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.1 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.2 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.2 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.3 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.3 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.4 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.4 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.5 enum value to the version response property for the response status 200 (media type: application/json; version=2.4.5)
  response-property-enum-value-added
- ●
  added the new 2.4.5 enum value to the version response property for the response status 200 (media type: application/xlsx; version=2.4.5)
  response-property-enum-value-added
- ○
  added the new 2.4.1 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.1 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.1 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.2 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.2 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.2 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.3 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.3 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.3 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.4 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.4 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.4 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new 2.4.5 enum value to the request property version (media type: application/json)
  request-property-enum-value-added
- ○
  added the new 2.4.5 enum value to the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-added
- ○
  added the new 2.4.5 enum value to the request property version (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  media type application/json; version=2.3.5 was changed to application/json; version=2.4.5 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.3.5 was changed to application/xlsx; version=2.4.5 for the response status 200
  response-media-type-name-changed
Aug 19, 20228446ece0e1483928See the full diff
- ▲
  removed the enum value 2.4.1 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.1 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.1 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.10 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.10 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.10 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.11 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.11 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.11 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.12 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.12 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.12 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.13 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.13 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.13 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.2 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.2 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.2 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.3 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.3 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.3 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.4 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.4 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.4 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.5 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.5 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.5 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.6 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.6 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.6 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.7 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.7 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.7 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.8 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.8 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.8 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.9 of the request property version (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.9 of the request property version (media type: application/x-www-form-urlencoded)
  request-property-enum-value-removed
- ▲
  removed the enum value 2.4.9 of the request property version (media type: multipart/form-data)
  request-property-enum-value-removed
- ○
  media type application/json; version=2.4.13 was changed to application/json; version=2.3.5 for the response status 200
  response-media-type-name-changed
- ○
  media type application/xlsx; version=2.4.13 was changed to application/xlsx; version=2.3.5 for the response status 200
  response-media-type-name-changed
- ○
  removed the 2.4.1 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.1 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.10 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.10 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.11 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.11 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.12 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.12 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.13 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.13 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.2 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.2 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.3 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.3 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.4 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.4 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.5 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.5 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.6 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.6 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.7 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.7 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.8 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.8 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.9 enum value from the version response property for the response status 200 (media type: application/json; version=2.3.5)
  response-property-enum-value-removed
- ○
  removed the 2.4.9 enum value from the version response property for the response status 200 (media type: application/xlsx; version=2.3.5)
  response-property-enum-value-removed
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history