Skip to main content
GET
/
webhook-subscriptions
List webhook subscriptions
curl --request GET \
  --url https://api.pictify.io/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "subscriptions": [
    {
      "uid": "<string>",
      "targetUrl": "<string>",
      "filters": {
        "templateId": "<string>",
        "bindingId": "<string>"
      },
      "deliveryCount": 123,
      "failureCount": 123,
      "lastDeliveryAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNext": true,
    "hasPrev": true
  }
}

​
Webhook Subscriptions

Manage webhook subscriptions programmatically. Webhooks notify your server when events occur in your Pictify account.
For webhook payload formats and signature verification, see Webhooks Concept.

​
Endpoints

MethodEndpointDescription
GET/webhook-subscriptionsList subscriptions
POST/webhook-subscriptionsCreate subscription
GET/webhook-subscriptions/{uid}Get subscription
PUT/webhook-subscriptions/{uid}Update subscription
DELETE/webhook-subscriptions/{uid}Delete subscription
The secret is only returned when creating a subscription. Store it securely for signature verification.

​
Supported Events

EventDescription
render.completedImage, GIF, or PDF render finished successfully
render.failedRender failed with an error
binding.updatedBinding data refreshed
binding.failedBinding data fetch failed

​
Filters

Filter webhooks to only receive specific events by template or render type: 
{
  "filters": {
    "templateId": "tmpl_abc123",
    "type": "image"
  }
}

​
Subscription Status

StatusDescription
activeReceiving webhooks
pausedTemporarily disabled
failedDisabled after repeated delivery failures

​
Delivery Information

The lastDelivery field on a subscription shows the most recent delivery attempt, including status, timestamp, responseCode, and retry information for failures.

Authorizations

​
Authorization
string
header
required

API key obtained from the Pictify dashboard

Query Parameters

​
event
string
​
status
enum<string>
Available options:
active,
paused,
failed
​
page
integer
default:1
​
limit
integer
default:20

Response

200 - application/json

List of subscriptions

​
subscriptions
object[]
​
pagination
object