Create a webhook

POST

subgraphs

webhooks

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "webhook_secret": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API token generated from the Goldsky Dashboard. Pass as: Authorization: Bearer

Body

application/json

name

string

required

A project-unique name for the webhook.

Maximum string length: 42

subgraph_name

string

required

Pattern: ^[a-zA-Z][\w-]*$

subgraph_version

string

required

Pattern: ^[a-zA-Z0-9][\w+.-]*$

entity

string

required

The subgraph entity (table) to stream row changes from. Use the entities endpoint to list valid values.

webhook_url

string

required

The URL row changes are POSTed to.

secret

string

Sent as the goldsky-webhook-secret header on every delivery. Generated if omitted, and returned once in the create response.

num_retries

integer

Required range: 0 <= x <= 10

retry_interval_seconds

integer

Required range: x >= 1

retry_timeout_seconds

integer

Required range: x >= 1

Response

200 - application/json

Default Response

data

object

required

Show child attributes

⌘I

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "webhook_secret": "<string>"
  }
}

Overview

Solutions

More information

Pipelines

Pipeline Authoring

Pipeline Lifecycle

Pipeline Logs

Pipeline Status

Subgraphs

Catalogs

Subgraph Lifecycle

Subgraph Logs

Subgraph Tags

Subgraph Deployments

Subgraph Webhooks

Edge Endpoints

Edge Lifecycle

Edge API Keys

Edge Metrics

Create a webhook

Authorizations

Body

Response