Skip to main content
POST
/
v1
/
server
/
webhooks
Create Webhook
curl --request POST \
  --url https://sdk-api.playcamp.io/v1/server/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "coupon.redeemed",
  "url": "<string>",
  "retryCount": 3,
  "timeoutMs": 5000
}
'
{
  "data": {
    "id": 123,
    "eventType": "coupon.redeemed",
    "url": "<string>",
    "isActive": true,
    "retryCount": 123,
    "timeoutMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Server API Key (format: {keyId}:{secret})

Body

application/json
​
eventType
enum<string>
required

Webhook event types:

  • coupon.redeemed: Coupon redeemed
  • payment.created: Payment created
  • sponsor.created: Boost created (Sponsor)
Available options:
coupon.redeemed,
payment.created,
payment.bulk_created,
sponsor.created,
sponsor.ended
​
url
string<uri>
required

Webhook receiver URL

​
retryCount
integer
default:3

Retry count on failure

Required range: 0 <= x <= 10
​
timeoutMs
integer
default:5000

Timeout (milliseconds)

Required range: 1000 <= x <= 30000

Response

201 - application/json

Success (secret is only returned in this response)

​
data
object
required

Webhook creation response (includes secret)