Webhooks

List Webhooks

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32Optional

perPageinteger · int32Optional

Responses

200

List of webhooks

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/webhooks

HTTPcURLJavaScriptPython

GET /v2/webhooks HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "42",
      "url": "https://sweet-webhooks.com/my/webhook/endpoint",
      "events": [
        "quote-sent",
        "quote-accepted"
      ],
      "token": "123456",
      "enabled": true,
      "timestamp": {
        "created": 1490737206,
        "updated": 1490737206
      }
    }
  ]
}

Create Webhook

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

A unique ID for the Webhook. Ignored when creating & updating webhooks.

urlstringRequired

The URL of the webhook, which will receive requests with data for any events fired that fall within the events of the Webhook.

tokenstringOptional

A string used to hash the webhook body for verification.

enabledbooleanOptional

Whether or not the Webhook is enabled/active.

Responses

200

Details about the new Webhook

application/json

idstringOptional

A unique ID for the Webhook. Ignored when creating & updating webhooks.

urlstringRequired

The URL of the webhook, which will receive requests with data for any events fired that fall within the events of the Webhook.

tokenstringOptional

A string used to hash the webhook body for verification.

enabledbooleanOptional

Whether or not the Webhook is enabled/active.

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/webhooks

HTTPcURLJavaScriptPython

POST /v2/webhooks HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "id": "42",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "events": [
    "quote-status-changed",
    "quote-created"
  ],
  "token": "123456",
  "enabled": true,
  "timestamp": {
    "created": 1490737206,
    "updated": 1490737206
  }
}

{
  "id": "42",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "events": [
    "quote-status-changed",
    "quote-created"
  ],
  "token": "123456",
  "enabled": true,
  "timestamp": {
    "created": 1490737206,
    "updated": 1490737206
  }
}

Retrieve Webhook

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Webhooks

Responses

200

Details about the webhooks

application/json

idstringOptional

A unique ID for the Webhook. Ignored when creating & updating webhooks.

urlstringRequired

The URL of the webhook, which will receive requests with data for any events fired that fall within the events of the Webhook.

tokenstringOptional

A string used to hash the webhook body for verification.

enabledbooleanOptional

Whether or not the Webhook is enabled/active.

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/webhooks/{id}

HTTPcURLJavaScriptPython

GET /v2/webhooks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "42",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "events": [
    "quote-status-changed",
    "quote-created"
  ],
  "token": "123456",
  "enabled": true,
  "timestamp": {
    "created": 1490737206,
    "updated": 1490737206
  }
}

Update Webhook

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Webhook

Body

application/json

idstringOptional

A unique ID for the Webhook. Ignored when creating & updating webhooks.

urlstringRequired

The URL of the webhook, which will receive requests with data for any events fired that fall within the events of the Webhook.

tokenstringOptional

A string used to hash the webhook body for verification.

enabledbooleanOptional

Whether or not the Webhook is enabled/active.

Responses

200

The updated webhook

application/json

idstringOptional

A unique ID for the Webhook. Ignored when creating & updating webhooks.

urlstringRequired

The URL of the webhook, which will receive requests with data for any events fired that fall within the events of the Webhook.

tokenstringOptional

A string used to hash the webhook body for verification.

enabledbooleanOptional

Whether or not the Webhook is enabled/active.

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/webhooks/{id}

HTTPcURLJavaScriptPython

PUT /v2/webhooks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "id": "42",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "events": [
    "quote-status-changed",
    "quote-created"
  ],
  "token": "123456",
  "enabled": true,
  "timestamp": {
    "created": 1490737206,
    "updated": 1490737206
  }
}

{
  "id": "42",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "events": [
    "quote-status-changed",
    "quote-created"
  ],
  "token": "123456",
  "enabled": true,
  "timestamp": {
    "created": 1490737206,
    "updated": 1490737206
  }
}

Delete Webhook

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Webhook

Responses

204

No Content

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /v2/webhooks/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content