Patch an outgoing webhook configuration

PATCH

/api/v1/outgoing-webhooks/{webhook_id}

curl --request PATCH \
  --url https://external-api.moja-ai.com/api/v1/outgoing-webhooks/example \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "description": "example", "event_type_id": "example", "url": "example", "method": "GET", "params": {}, "headers": {}, "body": {}, "body_type": "json", "external_id": "example" }'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

webhook_id

required

Webhook Id

string

Header Parameters

X-API-Key

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

OutgoingWebhookPatch

object

name

Any of:

string

string

>= 1 characters <= 255 characters

null

null

description

Any of:

string

string

null

null

event_type_id

Any of:

string

string

>= 1 characters

null

null

url

Any of:

string

string

>= 1 characters <= 500 characters

null

null

method

Any of:

string

string

Allowed values: GET POST PUT PATCH DELETE

null

null

params

Any of:

object

object

key

additional properties

any

null

null

headers

Any of:

object

object

key

additional properties

any

null

null

body

Any of:

object

object

key

additional properties

any

null

null

body_type

Any of:

string

string

Allowed values: json form_data

null

null

external_id

Any of:

string

string

>= 1 characters <= 64 characters

null

null

Responses

200

Successful Response

Media typeapplication/json

OutgoingWebhookResponse

object

id

required

Id

string

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

org_id

required

Org Id

string

name

required

Name

string

description

Any of:

string

string

null

null

event_type_id

required

Event Type Id

string

event_type

Any of:

EventTypeResponse

EventTypeResponse

object

id

required

Id

string

name

required

Name

string

internal_name

required

Internal Name

string

description

Any of:

string

string

null

null

null

null

url

required

Url

string

method

required

Method

string

params

Any of:

object

object

key

additional properties

any

null

null

headers

Any of:

object

object

key

additional properties

any

null

null

body

Any of:

object

object

key

additional properties

any

null

null

body_type

required

Body Type

string

external_id

Any of:

string

string

null

null

Example^generated

{
  "id": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "org_id": "example",
  "name": "example",
  "description": "example",
  "event_type_id": "example",
  "event_type": {
    "id": "example",
    "name": "example",
    "internal_name": "example",
    "description": "example"
  },
  "url": "example",
  "method": "example",
  "params": {},
  "headers": {},
  "body": {},
  "body_type": "example",
  "external_id": "example"
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}