Incoming Sources

Create incoming source

Creates a new incoming webhook source for the project

post/api/v1/projects/{projectId}/incoming-sources

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/incoming-sources
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required

Request body

namestring required

Display name for the source

slugstring

URL-friendly slug (auto-generated if omitted)

providerTypestring

GENERIC, or the id of a provider listed by GET /api/v1/incoming-providers

status'ACTIVE' | 'DISABLED'

Source status

verificationMode'NONE' | 'HMAC_GENERIC' | 'PROVIDER'

Signature verification mode

hmacSecretstring

HMAC secret for signature verification (write-only, never returned)

hmacHeaderNamestring

HTTP header name containing the signature

hmacSignaturePrefixstring

Prefix before the signature value

rateLimitPerSecondinteger

Rate limit per second for the ingress URL, at most the plan's own (null = the default limit)

Example request

{
  "name": "GitHub Webhooks",
  "slug": "github-webhooks",
  "providerType": "GITHUB",
  "hmacHeaderName": "X-Hub-Signature-256",
  "hmacSignaturePrefix": "sha256=",
  "rateLimitPerSecond": 100
}

Response

Source created

Changes

No recorded changes to this operation across all 1 revision of this API.