Skip to main content
POST
/
v2
/
webhooks
/
register
Register Webhook
curl --request POST \
  --url https://b2b-api.dev-riseworks.io/v2/webhooks/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_nanoid": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "secret": "<string>",
  "team_nanoid": "<string>",
  "is_active": true,
  "name": "<string>",
  "description": "<string>"
}
'
{
  "success": true,
  "data": {
    "webhook_nanoid": "<string>",
    "company_nanoid": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "is_active": true,
    "name": "<string>",
    "description": "<string>",
    "team_nanoid": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
company_nanoid
string
required

Unique identifier of the company.

Required string length: 15
Pattern: ^co-.*
​
url
string<uri>
required
​
events
string[]
required
Minimum array length: 1
​
secret
string
required
Minimum string length: 16
​
team_nanoid
string

Unique identifier of the team.

Required string length: 15
Pattern: ^te-.*
​
is_active
boolean
​
name
string

Optional display name for the webhook.

Maximum string length: 255
​
description
string

Optional description for the webhook.

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object
required