Update webhooks

post https://api.reepay.com/v1/webhook/update

Webhooks can be updated and re-sent in one operation. New URL, optional HTTP username, optional HTTP password, and a list of webhook ids or event ids identifying the webhooks must be provided. A maximum of 100 ids is allowed for each request.

Returns an array of Webhooks, containing all the updated webhooks. The webhooks state will have been set to pending.

Responses

Response body

array of objects

object

string

required

length ≥ 1

Unique webhook id assigned by Frisbii

event

string

required

length ≥ 1

Event id of the event this webhook is for

state

string

required

length ≥ 1

The webhook state, one of the following: pending, retrying, disabled, failed, completed

pending retrying disabled failed completed

url

string

required

length ≥ 1

Webhook url

username

string

Optional basic auth username

password

string

Optional basic auth password (masked)

content

string

required

length ≥ 1

JSON content of the webhook

created

date-time

required

Creation date in ISO-8601 extended offset date-time format.

success

date-time

Date of successful invocation in ISO-8601 extended offset date-time format.

count

int32

required

Number of invocations performed

last_fail

date-time

Date of last failed invocation in ISO-8601 extended offset date-time format.

first_fail

date-time

Date of first failed invocation in ISO-8601 extended offset date-time format.

alert_count

int32

Number of failed invocations before an alert email is sent

alert_sent

date-time

Date when an optional alert email sending was requested in ISO-8601 extended offset date-time format.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.reepay.com/v1/webhook/update \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
18
 
1
[
2
  {
3
    "id": "dafba2016614418f969fa5697383e47c",
4
    "event": "a7a7195c54f644369922d0dfe794dd0c",
5
    "state": "pending",
6
    "url": "https://api.ownserver.com/webhook",
7
    "username": "username",
8
    "password": "password",
9
    "content": "{\"invoice\":\"a7a7195c54f644369922d0dfe794dd0c\", .... }",
10
    "created": "2015-04-04T12:40:56.656Z",
11
    "success": "2015-04-04T12:40:56.656Z",
12
    "count": 2,
13
    "last_fail": "2015-04-04T12:40:56.656Z",
14
    "first_fail": "2015-04-04T12:40:56.656Z",
15
    "alert_count": 2,
16
    "alert_sent": "2015-04-04T12:40:56.656Z"
17
  }
18
]

200Successful operation

400Invalid request, see error codes at https://api.reepay.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.reepay.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii