Skip to content

triggers.setTriggerWebhook

PUT
/v1/triggers/{triggerId}/webhook
curl --request PUT \
--url https://example.com/v1/triggers/example/webhook \
--header 'Authorization: Bearer <token>'

Makes a new webhook secret. The old secret stops working. The caller becomes the actor of the trigger.

triggerId
required
string
>= 1 characters <= 128 characters

Success

Media typeapplication/json
object
url
required
string
secret
required
string

Example generated

{
"url": "example",
"secret": "example"
}

TriggerInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: TriggerInvalid
message
required
string

Example

{
"_tag": "TriggerInvalid"
}

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example

{
"_tag": "AuthenticationRequired"
}

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example

{
"_tag": "Forbidden"
}

TriggerNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: TriggerNotFound
id
required
string

Example

{
"_tag": "TriggerNotFound"
}

@nmnmcc/ability/Authorizer/Pending | TriggerConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Pending
ticket
required
string
reason
string

Example

{
"_tag": "Pending"
}

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example

{
"_tag": "RateLimited"
}

TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PolicyUnavailable

Example

{
"_tag": "PolicyUnavailable"
}