Skip to main content
POST
Create a new webhook

Body

application/json
projectId
string
required

Project ID this webhook belongs to

Example:

"proj_123abc"

name
string
required

Webhook name for identification

Maximum string length: 255
Example:

"Player Events Webhook"

url
string
required

URL to deliver webhook payloads to

Maximum string length: 500
Example:

"https://api.yourapp.com/webhooks/engagefabric"

events
array[]
required

Event types to subscribe to

Example:
description
string

Description of the webhook purpose

Example:

"Sends player level-up events to our rewards service"

headers
object

Custom headers to include in webhook requests

Example:
maxConsecutiveFailures
number
default:10

Maximum consecutive failures before auto-disable (0 = never)

Example:

10

rateLimit
number
default:1000

Rate limit in requests per hour (0 = unlimited)

Example:

1000

maxRetries
number
default:3

Maximum retry attempts for failed deliveries

Example:

3

retryDelaySeconds
number
default:60

Delay in seconds between retry attempts

Example:

60

Response

201 - application/json
id
string
required
Example:

"wh_123abc"

projectId
string
required
Example:

"proj_456def"

name
string
required
Example:

"Player Events Webhook"

url
string
required
Example:

"https://api.yourapp.com/webhooks/engagefabric"

events
array[]
required
Example:
isActive
boolean
required
Example:

true

maxConsecutiveFailures
number
required
Example:

10

rateLimit
number
required
Example:

1000

maxRetries
number
required
Example:

3

retryDelaySeconds
number
required
Example:

60

consecutiveFailures
number
required
Example:

0

totalDeliveries
number
required
Example:

1500

successfulDeliveries
number
required
Example:

1480

failedDeliveries
number
required
Example:

20

createdAt
string
required
Example:

"2024-01-01T00:00:00Z"

updatedAt
string
required
Example:

"2024-01-15T10:30:00Z"

description
string
Example:

"Sends player level-up events to our rewards service"

headers
object
Example:
lastTriggeredAt
string
Example:

"2024-01-15T10:30:00Z"

lastSuccessAt
string
Example:

"2024-01-15T10:30:00Z"

lastFailureAt
string
Example:

"2024-01-14T08:00:00Z"