accounting/accounts3

accounting/addresses2

accounting/attachments3

accounting/balancesheets2

accounting/cashflowstatements2

accounting/companyinfos2

accounting/contacts3

accounting/creditnotes2

accounting/expenses3

accounting/incomestatements2

accounting/invoices3

accounting/items2

accounting/journalentries3

accounting/payments3

accounting/phonenumbers2

accounting/purchaseorders3

accounting/taxrates2

accounting/trackingcategories2

accounting/transactions2

accounting/vendorcredits2

auth1

connections1

crm/companies3

crm/contacts3

crm/deals3

crm/engagements3

crm/notes3

crm/stages2

crm/tasks3

crm/users2

ecommerce/customers2

ecommerce/fulfillments2

ecommerce/orders3

ecommerce/products3

events1

fieldMappings6

filestorage/files3

filestorage/folders3

filestorage/groups2

filestorage/users2

linkedUsers5

marketingautomation/actions3

marketingautomation/automations3

marketingautomation/campaigns3

marketingautomation/contacts3

marketingautomation/emails2

marketingautomation/events2

marketingautomation/lists3

marketingautomation/messages2

marketingautomation/templates3

marketingautomation/users2

passthrough2

projects2

sync4

ticketing/accounts2

ticketing/attachments3

ticketing/collections2

ticketing/comments3

ticketing/contacts2

ticketing/tags2

ticketing/teams2

ticketing/tickets3

ticketing/users2

webhooks5

webhooks

Create webhook

post/webhooks

Request body

urlstring nullable required

The endpoint url of the webhook.

descriptionstring nullable required

The description of the webhook.

scopestring[] nullable required

The events that the webhook listen to.

Example request

{
  "url": "https://acme.com/webhook_receiver",
  "description": "Webhook to receive connection events",
  "scope": [
    "connection.created"
  ]
}

Response

id_webhook_endpointstring nullable required

The unique UUID of the webhook.

endpoint_descriptionstring nullable required

The description of the webhook.

urlstring nullable required

The endpoint url of the webhook.

secretstring required

The secret of the webhook.

activeboolean nullable required

The status of the webhook.

created_atstring date-time nullable required

The created date of the webhook.

scopestring[] nullable required

The events that the webhook listen to.

id_projectstring nullable required

The project id tied to the webhook.

last_updatestring date-time nullable required

The last update date of the webhook.

Example response

{
  "id_webhook_endpoint": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "endpoint_description": "Webhook to receive connection events",
  "url": "https://acme.com/webhook_receiver",
  "secret": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "active": true,
  "created_at": "2024-10-01T12:00:00Z",
  "scope": [
    "connection.created"
  ],
  "id_project": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "last_update": "2024-10-01T12:00:00Z"
}

Changes

Changed in 10 of the 18 revisions of this API.138

Nov 18, 2024ef360d76c6581See the full diff
- ▲
  the request property description became required
  request-property-became-required
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 202417251bf7794f1See the full diff
- ○
  the request property description became optional
  request-property-became-optional
Aug 9, 20243539cfe8509c1See the full diff
- ▲
  the request property description became required
  request-property-became-required
Aug 7, 20243ce49f5aad531See the full diff
- ○
  the request property description became optional
  request-property-became-optional
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 5, 2024ca0fa45ebd051See the full diff
- ▲
  the request property description became required
  request-property-became-required
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 5, 2024ca213ae36b7f1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 5, 2024167edd5346ec1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 3, 20249d25bd589fe973See the full diff
- ▲
  the response property active became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property id_project became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property id_webhook_endpoint became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property scope became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property secret became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property url became nullable for the status 201
  response-property-became-nullable
- ○
  the request property description became nullable
  request-property-became-nullable
- ○
  the request property scope became nullable
  request-property-became-nullable
- ○
  the request property url became nullable
  request-property-became-nullable
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 2024414c3e999e0b21See the full diff
- ▲
  the response property endpoint_description became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property last_update became nullable for the status 201
  response-property-became-nullable
- ○
  the request property description became optional
  request-property-became-optional
Aug 1, 2024f48b82299d9d1See the full diff
- ○
  endpoint added
  endpoint-added

Full history