Create

With this endpoint, you can create a Webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

enable_events description

enable_events are the web hooks types

DescriptionCode
FGTS Installments1
Operation Status2

Response

Http CodeReturn CodeMessage
200200-01Success.
400400-01Something unexpected happened.
400400-11Error registering.
400400-37Invalid type for field 'X'
400400-59Enabled_events not found.
401401-05Unauthorized or token invalid
406406-03field 'X' is mandatory and was not informed.
429429-01Too many requests

Response Parameters

ParameterFormatDescription
request_codeStringRequest identification code.
returnBooleanIndicates if the request was successful.
return_codeStringReturn code of the request.
messageStringReturn message of the request.
data.codeStringUnique code associated with the successfully created Webhook.

Request Parameters

Body Params
string
required
Defaults to https://api.com/webhook

Endpoint

string
required
Defaults to POST

Method

enabled_events
array of int32s
required
Defaults to 1

Allowed events

enabled_events*
headers
object
required

Headers

string
Defaults to Example Webhook

Webhook name

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json