Create a webhook. The response holds the signing secret once.

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/webhooks" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"name":"<name>","url":"<url>","event":"invite_sent"}'

Responses

201400401403409429503

Response 201

Success

application/json

Example responseGenerated from schema

{
  "id": 0,
  "name": "name",
  "url": "url",
  "event": "invite_sent",
  "campaignIds": [
    0
  ],
  "active": true,
  "createdAt": "createdAt",
  "secret": "secret"
}

Response 400

The request is not valid. error.fields lists each problem.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 409

The Idempotency-Key belongs to a different request, or the state does not allow this action.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Request body

Required

Yes

Content type

• application/json

• namestringrequired
• urlstringrequired
• eventstringrequired
  Allowed values: invite_sent, invite_accepted, message_sent, message_reply, inmail_sent, inmail_reply, follow_sent, post_liked, profile_viewed, campaign_completed, lead_tag_updated, lead_finished_without_reply, every_reply, lead_auto_tagged_positive, lead_auto_tagged_negative, lead_auto_tagged_generic
• campaignIdsnumber[]optional

  Only events of these campaigns. Empty means all.

• activebooleanoptional
  Default: true

Returns

Schema shown for 201 · application/json

• idnumber
• namestring
• urlstring
• eventstring
  Allowed values: invite_sent, invite_accepted, message_sent, message_reply, inmail_sent, inmail_reply, follow_sent, post_liked, profile_viewed, campaign_completed, lead_tag_updated, lead_finished_without_reply, every_reply, lead_auto_tagged_positive, lead_auto_tagged_negative, lead_auto_tagged_generic
• campaignIdsnumber[]
• activeboolean
• createdAtstring
• secretstring

  Signing secret. The API shows it once.