Webhooks

Manage webhook subscriptions for real-time events (post.scheduled, post.published, post.failed). Deliveries are signed with HMAC-SHA256.

List webhooks

GET

/webhooks

List webhooks › Responses

200

List of webhooks

Webhook[]

Create a webhook

POST

/webhooks

Create a webhook › Request Body

url

string · uri · required

HTTPS URL to receive events

events

string[] · required

Enum values:

post.scheduled

post.published

post.failed

Create a webhook › Responses

Webhook created. The secret is only returned once at creation.

object

message

string

POST/webhooks

curl /webhooks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "post.scheduled"
  ]
}'

Example Request Body

{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "post.scheduled"
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "url": "https://www.example.com/path/to/resource",
    "events": [
      "post.scheduled"
    ],
    "is_active": true,
    "last_triggered_at": "2024-08-25T15:00:00Z",
    "failure_count": 0,
    "last_failure": {
      "at": "2024-08-25T15:00:00Z",
      "status": 0,
      "error": "error",
      "attempts": 0
    },
    "created_at": "2024-08-25T15:00:00Z",
    "secret": "secret"
  },
  "message": "message"
}

json

application/json

Get webhook details

GET

/webhooks/{id}

Get webhook details › path Parameters

id

string · required

Get webhook details › Responses

Webhook details

Webhook

Delete a webhook

DELETE

/webhooks/{id}

Delete a webhook › path Parameters

id

string · required

Delete a webhook › Responses

Webhook deleted

No data returned

Update a webhook

PATCH

/webhooks/{id}

Update a webhook › path Parameters

id

string · required

Update a webhook › Request Body

url

string · uri

events

string[]

is_active

boolean

Update a webhook › Responses

Webhook updated

Webhook

PATCH/webhooks/{id}

curl /webhooks/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "string"
  ],
  "is_active": true
}'

Example Request Body

{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "string"
  ],
  "is_active": true
}

json

Example Responses

{
  "data": {
    "id": "id",
    "url": "https://www.example.com/path/to/resource",
    "events": [
      "post.scheduled"
    ],
    "is_active": true,
    "last_triggered_at": "2024-08-25T15:00:00Z",
    "failure_count": 0,
    "last_failure": {
      "at": "2024-08-25T15:00:00Z",
      "status": 0,
      "error": "error",
      "attempts": 0
    },
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Rotate webhook secret

POST

/webhooks/{id}/rotate-secret

Rotate webhook secret › path Parameters

id

string · required

Rotate webhook secret › Responses

New secret generated. Save it — it will only be shown once.

object

message

string

Analytics Locations

OmniSocials API

Webhooks

Manage webhook subscriptions for real-time events (post.scheduled, post.published, post.failed). Deliveries are signed with HMAC-SHA256.

List webhooks

GET

/webhooks

List webhooks › Responses

200

List of webhooks

Webhook[]

Create a webhook

POST

/webhooks

Create a webhook › Request Body

url

string · uri · required

HTTPS URL to receive events

events

string[] · required

Enum values:

post.scheduled

post.published

post.failed

Create a webhook › Responses

Webhook created. The secret is only returned once at creation.

object

message

string

POST/webhooks

curl /webhooks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "post.scheduled"
  ]
}'

Example Request Body

{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "post.scheduled"
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "url": "https://www.example.com/path/to/resource",
    "events": [
      "post.scheduled"
    ],
    "is_active": true,
    "last_triggered_at": "2024-08-25T15:00:00Z",
    "failure_count": 0,
    "last_failure": {
      "at": "2024-08-25T15:00:00Z",
      "status": 0,
      "error": "error",
      "attempts": 0
    },
    "created_at": "2024-08-25T15:00:00Z",
    "secret": "secret"
  },
  "message": "message"
}

json

application/json

Get webhook details

GET

/webhooks/{id}

Get webhook details › path Parameters

id

string · required

Get webhook details › Responses

Webhook details

Webhook

Delete a webhook

DELETE

/webhooks/{id}

Delete a webhook › path Parameters

id

string · required

Delete a webhook › Responses

Webhook deleted

No data returned

Update a webhook

PATCH

/webhooks/{id}

Update a webhook › path Parameters

id

string · required

Update a webhook › Request Body

url

string · uri

events

string[]

is_active

boolean

Update a webhook › Responses

Webhook updated

Webhook

PATCH/webhooks/{id}

curl /webhooks/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "string"
  ],
  "is_active": true
}'

Example Request Body

{
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "string"
  ],
  "is_active": true
}

json

Example Responses

{
  "data": {
    "id": "id",
    "url": "https://www.example.com/path/to/resource",
    "events": [
      "post.scheduled"
    ],
    "is_active": true,
    "last_triggered_at": "2024-08-25T15:00:00Z",
    "failure_count": 0,
    "last_failure": {
      "at": "2024-08-25T15:00:00Z",
      "status": 0,
      "error": "error",
      "attempts": 0
    },
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Rotate webhook secret

POST

/webhooks/{id}/rotate-secret

Rotate webhook secret › path Parameters

id

string · required

Rotate webhook secret › Responses

New secret generated. Save it — it will only be shown once.

object

message

string

Analytics Locations