Retrieve a webhook by its ID

GET 
/webhook/:webhookId

Retrieve a webhook by its ID

Request

Path Parameters

webhookId stringrequired

The unique ID of the webhook to retrieve.

Responses

200

Webhook retrieved successfully

application/json

Schema

Schema

url urirequired

The URL to which the webhook will send event data.

id string

Unique identifier of the webhook

resource stringrequired

Possible values: [schema]

Resource to attach the webhook to

eventType stringrequired

Possible values: [submission_approved]

Event type that triggers the webhook.

resourceId stringrequired

Identifier of the resource to attach webhook to

createdAt date-time

Time representation of entity creation

headers string

Custom headers to include in the webhook request, such as authentication tokens.

projectId string

Unique identifier of the project to which webhook is related

body string

The body for the webhook request, supporting variables.

Example (from schema)

{
  "url": "https://example.com/webhook/$userId",
  "id": "a1fb86bad-de7c-4ed7-a1c6-538db2b0c9ed",
  "resource": "schema",
  "eventType": "submission_approved",
  "resourceId": "s12RHo2ET",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "headers": "{\"Bearer\": \"$bearertoken\", \"customHeader\": \"$customHeader\"}",
  "projectId": "p2Duhf5N6",
  "body": "{\"userId\": \"$userId\", \"resource\": \"$resource\", \"resourceId\": \"$resourceId\"}"
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

Loading...