Webhook Endpoints

Webhook endpoint management

List webhook-endpoints

get

Retrieve a paginated list of webhook-endpoints

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Query parameters

pageintegerOptional

Page number

Example: 1

per_pageinteger · max: 100Optional

Items per page (max 100)

Example: 25

sortstringOptional

Sort field (prefix with - for descending)

Example: -created_at

Responses

200

Successful response with paginated list

application/json

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

get

/v2/webhook-endpoints/

HTTPcURLJavaScriptPython

GET /v2/webhook-endpoints/ HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 150,
    "pages": 6
  }
}

Create webhook endpoint

post

Create a new webhook endpoint for the authenticated OAuth client

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Body

application/json

urlstring · uri · max: 2048Required

URL to receive webhook events

Example: https://example.com/webhooks/spiffy

descriptionstring · max: 255 · nullableOptional

Human-readable description of the webhook

Example: Production webhook endpoint

eventsstring[]Optional

List of event types to subscribe to (defaults to ['*'])

Example: ["order.created","order.completed"]

Responses

201

Created successfully

application/json

400

Bad Request - The request was invalid or malformed

application/json

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

409

Conflict - The request conflicts with the current state of the resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

post

/v2/webhook-endpoints/

HTTPcURLJavaScriptPython

POST /v2/webhook-endpoints/ HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "url": "https://example.com/webhooks/spiffy",
  "description": "Production webhook endpoint",
  "events": [
    "order.created",
    "order.completed"
  ]
}

No content

Get webhook-endpoints

get

Retrieve a single webhook-endpoints by ID

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Responses

200

Successful response

application/json

anyOptional

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

404

Not Found - The requested resource does not exist

application/json

500

Internal Server Error - An unexpected error occurred

application/json

get

/v2/webhook-endpoints/{id}

HTTPcURLJavaScriptPython

GET /v2/webhook-endpoints/{id} HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete webhook endpoint

delete

Delete a webhook endpoint

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Responses

204

Deleted successfully

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

delete

/v2/webhook-endpoints/{id}

HTTPcURLJavaScriptPython

DELETE /v2/webhook-endpoints/{id} HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update webhook endpoint

patch

Update a webhook endpoint configuration

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Body

application/json

urlstring · uri · max: 2048Optional

URL to receive webhook events

Example: https://example.com/webhooks/spiffy

descriptionstring · max: 255 · nullableOptional

Human-readable description of the webhook

Example: Production webhook endpoint

eventsstring[]Optional

List of event types to subscribe to

Example: ["order.created","order.completed"]

statusstring · enumOptional

Webhook status (active or inactive)

Example: activePossible values:

Responses

200

Successful response

application/json

anyOptional

400

Bad Request - The request was invalid or malformed

application/json

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

409

Conflict - The request conflicts with the current state of the resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

patch

/v2/webhook-endpoints/{id}

HTTPcURLJavaScriptPython

PATCH /v2/webhook-endpoints/{id} HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "url": "https://example.com/webhooks/spiffy",
  "description": "Production webhook endpoint",
  "events": [
    "order.created",
    "order.completed"
  ],
  "status": "active"
}

No content

POST /v2/webhook-endpoints/:id/rotate-secret

post

Endpoint: POST /v2/webhook-endpoints/:id/rotate-secret

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Responses

200

Successful response

No content

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

post

/v2/webhook-endpoints/{id}/rotate-secret

HTTPcURLJavaScriptPython

POST /v2/webhook-endpoints/{id}/rotate-secret HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

POST /v2/webhook-endpoints/:id/test

post

Endpoint: POST /v2/webhook-endpoints/:id/test

Authorizations

ApiKeyAuthOAuth2

AuthorizationstringRequired

Account API key authentication. Pass your API key as a Bearer token in the Authorization header. Grants full access to all endpoints — equivalent to all OAuth scopes.

Responses

200

Successful response

No content

401

Unauthorized - Authentication is required or has failed

application/json

403

Forbidden - You do not have permission to access this resource

application/json

500

Internal Server Error - An unexpected error occurred

application/json

post

/v2/webhook-endpoints/{id}/test

HTTPcURLJavaScriptPython

POST /v2/webhook-endpoints/{id}/test HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content